Skip to content

Commit

Permalink
docs: update ADR README
Browse files Browse the repository at this point in the history
  • Loading branch information
bryanchriswhite committed Apr 17, 2023
1 parent 9e722ec commit 858f973
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion ADRs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,31 @@ The generated ADR can then be reviewed and refined by the team members to ensure
To contribute a new ADR, please follow these steps:

1. Create a new branch for your ADR.
2. Copy the ADR template from `ADR_TEMPLATE.md` and create a new file with the appropriate number and title (e.g., `ADR0003-adopting-multiaddr.md`).
2. Copy the ADR template from `ADR_TEMPLATE.md` and create a new file with the next ADR number and title (e.g., `ADR0001-adopt-multiaddr.md`).
3. Fill in the necessary information in the new ADR file, following the template structure.
4. Use the large language model prompts, if desired, to generate or refine the ADR content.
5. Submit a pull request to merge your ADR branch into the main branch, including a brief description of the problem and solution.
6. Request a review from the team members, and address any feedback or suggestions provided.
7. Once approved, merge the pull request to update the repository with the new ADR.

## Process Flowchart

```mermaid
stateDiagram
state "In Review" as review
state "Changes Needed" as change
Idea --> Draft : Author opens a PR
Draft --> review : PR is marked 'Ready for Review'
review --> change : Reviewer requests changes
change --> review : Reviewer approves changes
review --> Accepted : PR is merged
Accepted --> Living : Status is changed to 'Living'
Draft --> Withdrawn : PR is closed
review --> Withdrawn: PR is closed
```

## Links

- [ADR GitHub org](https://adr.github.io/)
Expand Down

0 comments on commit 858f973

Please sign in to comment.