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

Move ADRs out of template #136

Closed
callumforrester opened this issue Mar 15, 2024 · 4 comments
Closed

Move ADRs out of template #136

callumforrester opened this issue Mar 15, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested

Comments

@callumforrester
Copy link
Contributor

Adopting the template, which contains 2 ADRs, is likely to cause numbering conflicts in projects with existing ADRs. A proposal discussed among @DiamondJoseph @joeshannon @gilesknap and @callumforrester is to move all ADRs out of the template into the top level of this repo, leaving the template blank.

@coretl any thoughts?

@callumforrester callumforrester added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested labels Mar 15, 2024
@DiamondJoseph
Copy link

I think that the 2 existing ADRs are valid decisions to assume that someone adopting the copier has made, and bootstrap the concept of ADRs. But any future ADRs that are decisions made for Copier are likely not decisions made by the host repository, and shouldn't be propagated.

@coretl
Copy link
Contributor

coretl commented Mar 15, 2024

I think that the 2 existing ADRs are valid decisions to assume that someone adopting the copier has made, and bootstrap the concept of ADRs. But any future ADRs that are decisions made for Copier are likely not decisions made by the host repository, and shouldn't be propagated.

What he said.

These: https://github.com/DiamondLightSource/python-copier-template/tree/main/docs/explanations/decisions will grow as we make decisions that are related to python-copier-template, but they don't make it into expanded templates.

These: https://github.com/DiamondLightSource/python-copier-template/tree/main/template/%7B%25%20if%20sphinx%20%25%7Ddocs%7B%25%20endif%20%25%7D/explanations/decisions should be static and there will only ever be 2 of them.

I suggest we keep it like it is, but renumber the conflicting ones if we ever adopt into something which already has ADRs

@callumforrester
Copy link
Contributor Author

It is very easy to forget, is all, we would have in DiamondLightSource/blueapi#384 if not for @DiamondJoseph

@coretl
Copy link
Contributor

coretl commented Mar 20, 2024

Agreed to close this in the spirit of pragmatism

@coretl coretl closed this as not planned Won't fix, can't repro, duplicate, stale Mar 20, 2024
joeshannon added a commit to DiamondLightSource/blueapi that referenced this issue Apr 10, 2024
Following on from discussion at:
DiamondLightSource/python-copier-template#136

Specifically, ADRs 0001 & 0002 will remain static in the
python-copier-template and no further ADRs will be added to the
template.

This will ensure there are no conflicts going forward with future
template updates.
joeshannon added a commit to DiamondLightSource/blueapi that referenced this issue Apr 12, 2024
Following on from discussion at:
DiamondLightSource/python-copier-template#136

Specifically, ADRs 0001 & 0002 will remain static in the
python-copier-template and no further ADRs will be added to the
template.

This will ensure there are no conflicts going forward with future
template updates.
joeshannon added a commit to DiamondLightSource/blueapi that referenced this issue Apr 12, 2024
Following on from discussion at:
DiamondLightSource/python-copier-template#136

Specifically, ADRs 0001 & 0002 will remain static in the
python-copier-template and no further ADRs will be added to the
template.

This will ensure there are no conflicts going forward with future
template updates.
ZohebShaikh pushed a commit to DiamondLightSource/blueapi that referenced this issue May 7, 2024
Following on from discussion at:
DiamondLightSource/python-copier-template#136

Specifically, ADRs 0001 & 0002 will remain static in the
python-copier-template and no further ADRs will be added to the
template.

This will ensure there are no conflicts going forward with future
template updates.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants