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

Create new ADRs in the "Proposed" state by default #61

Open
npryce opened this issue Jun 28, 2018 · 6 comments
Open

Create new ADRs in the "Proposed" state by default #61

npryce opened this issue Jun 28, 2018 · 6 comments

Comments

@npryce
Copy link
Owner

npryce commented Jun 28, 2018

Currently a new ADR is created in the Accepted state by default.

I suggest it is better to create new ADRs in the Proposed state. ADRs are meant to be discussed and agreed within a team. When team members are not all colocated, discussion can occur around or within the ADR document itself, until the team agree that the ADR is ready to be marked as Accepted.

This would also encourage teams to record proposed architecture decisions that are discussed and then rejected, along with the reasons for rejection.

@retnuh
Copy link

retnuh commented Jun 29, 2018

Makes sense to me. Another place we've seen discussion take place is on the PR for the ADR itself, but even then there was a "Proposal" phase that gets committed and a follow up with the relevant points from the discussion.

@npryce
Copy link
Owner Author

npryce commented Jul 23, 2018

This is not as easy as I first thought. Some commands treat the status "Accepted" as a special case (e.g. adr-new with the -s option). They would have to be changed to support Proposed and Accepted, or be more general (e.g. assume that the first non-blank line of the Status section is the status, handle the case when that is a link, etc.

Any conventions like this should be made "official": see #60

@simkimsia
Copy link

simkimsia commented Jan 17, 2019

Out of curiosity, how many states are there for ADR assumed by this tool and what are they? Btw, I like the idea of having a Proposed state by default.

All in all, I have seen Pending, Accepted, and Proposed. Are there more I'm not aware of?

@npryce
Copy link
Owner Author

npryce commented Jan 17, 2019 via email

@simkimsia
Copy link

simkimsia commented Jan 18, 2019

At the moment it’s free-form apart from apart from Accepted and Superceded

May I suggest documenting this? I be happy to make a PR on the README

@PeterMTaylor
Copy link

This is a good idea. I guess for a use case example would be that all incoming work and their definitions for discussion for the next period/cycle of time would show proposed status which triggers discussion. Once the conversations are over, majority of the items becomes approved or rejected, any left over in proposed status shows up in the next period/cycle.

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

No branches or pull requests

4 participants