Skip to content

Commit bab2554

Browse files
docs: update ADR README
1 parent 9e722ec commit bab2554

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

ADRs/README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,30 @@ The generated ADR can then be reviewed and refined by the team members to ensure
3434
To contribute a new ADR, please follow these steps:
3535

3636
1. Create a new branch for your ADR.
37-
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`).
37+
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`).
3838
3. Fill in the necessary information in the new ADR file, following the template structure.
3939
4. Use the large language model prompts, if desired, to generate or refine the ADR content.
4040
5. Submit a pull request to merge your ADR branch into the main branch, including a brief description of the problem and solution.
4141
6. Request a review from the team members, and address any feedback or suggestions provided.
4242
7. Once approved, merge the pull request to update the repository with the new ADR.
4343

44+
## Process Flowchart
45+
46+
```mermaid
47+
stateDiagram
48+
state "In Review" as review
49+
state "Changes Needed" as change
50+
51+
Idea --> Draft : Author opens a PR
52+
Draft --> review : PR is marked 'Ready for Review'
53+
review --> change : Reviewer requests changes
54+
change --> review : Reviewer approves changes
55+
review --> Accepted : PR is merged
56+
57+
Draft --> Withdrawn : PR is closed
58+
review --> Withdrawn: PR is closed
59+
```
60+
4461
## Links
4562

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

0 commit comments

Comments
 (0)