Protocol for creating an ADR

[AndrewSazonov]

To ensure agreement and adaptation of a new Architecture Design Record (ADR) we use the following protocol.

1. Suggestion Phase

1. At the appropriate GitHub level (Organization or Repo) create a new discussion (Idea or Poll category)
2. Prefix the name the discussion ADR Suggestion, and use a name that describes what the ADR concerns.
   • ADR Suggestion Method naming convention
3. Make sure that the other team members are aware that a new suggestion and invite for discussion.
4. When discussion is done the proposal is either accepted or closed

2. Accepted ADR

1. Created a new discussion under the ADR category.
2. Use an appropriate and descriptive name.
3. Description of the ADR discussion should be a resume of what has been accepted.
4. Add links to the original discussion.
5. Close the original discussion.

3. Tracking Implementation

1. Once the ADR is accepted and finalized, create a corresponding issue in the relevant repository (or repositories) to track its implementation. This can be done using the Create issue from discussion button on the right sidebar of the ADR discussion page.
2. If the ADR impacts multiple projects or components, create an epic or umbrella issue that includes a checklist of all sub-issues or tasks needed to implement the changes across affected codebases and documentation.

4. Revision Process

1. To revise an ADR one need to start a new discussion (Idea or Poll category).
2. When a decision has been reached in the new discussion the ADR can be updated.
3. The old ADR description should be added as a comment for to ADR discussion itself to maintain a history of the changes

Links to the original discussions: #14, #18