Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up Architecture Decision Records #20

Closed
4 of 5 tasks
Relequestual opened this issue Jun 16, 2021 · 1 comment · Fixed by #36
Closed
4 of 5 tasks

Set up Architecture Decision Records #20

Relequestual opened this issue Jun 16, 2021 · 1 comment · Fixed by #36
Assignees

Comments

@Relequestual
Copy link
Member

Relequestual commented Jun 16, 2021

We had a Discussion to see if we should adopt Architecture Decision Records (ADRs). There were no strong objections and a few clear benefits.

We should add ADRs to this repo, the spec repo, and the test repo.
I suggested we use ISO date as the file prefix as opposed to incrementing numbers, as this is less likely to cause a conflicts. This approach was also adopted for proposals in OAI.

Work to be done:

* I'm not currently clear if "all repos" is appropriate. For example, it wouldn't make sense for the mostly empty vocabularies repo. I think it makes sense to put these in a .github repo for the org, but I'm not sure they are currently working as expected.

@Relequestual Relequestual self-assigned this Jun 16, 2021
Relequestual added a commit to Relequestual/community that referenced this issue Jun 17, 2021
Relequestual added a commit to Relequestual/community that referenced this issue Jun 17, 2021
Relequestual added a commit that referenced this issue Jul 19, 2021
Work as per #20
@Relequestual Relequestual linked a pull request Aug 19, 2021 that will close this issue
@Relequestual
Copy link
Member Author

I'm tempted to create a new issue for "roll out to all repos".

In the first instance, it makes sense to just add the Issue and PR templates to a .github repo.
Later we can consider automating distribution of templates and other community files to specific repos.

@derberg has developed a tool for globally passing out workflows within a GitHub org, but we might want a modified version which can also handle other files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant