chore: Make use of common adr template (#2030)

To unify the ADR structure we added a template in the .github repo. This PR adds a helpful command to generate new ADRs from that template. Example: asciinema.org/a/56X6g1bA9NpWq0FxW8wDMRJ3g Ref: celestiaorg/celestia-app#1415 Co-authored-by: Hlib Kanunnikov <[email protected]>
celestiaorg · Apr 13, 2023 · e264069 · e264069
1 parent 8dc1af2
commit e264069
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 73 deletions.
diff --git a/Makefile b/Makefile
@@ -165,3 +165,8 @@ lint-imports:
 sort-imports:
 	@goimports-reviser -company-prefixes "github.com/celestiaorg"  -project-name "github.com/celestiaorg/celestia-node" -output stdout ./...
 .PHONY: sort-imports
+
+adr-gen:
+	@echo "--> Generating ADRs"
+	@curl -sSL https://raw.githubusercontent.com/celestiaorg/.github/main/adr-template.md > docs/architecture/adr-$(NUM)-$(TITLE).md
+.PHONY: adr-gen
diff --git a/docs/adr/README.md b/docs/adr/README.md
@@ -27,6 +27,10 @@ If recorded decisions turned out to be lacking, convene a discussion, record the
 
 Note the context/background should be written in the present tense.
 
-To start a new ADR, you can use this template: [adr-template.md](./adr-template.md)
+To start a new ADR, you can generate a new file with the following command:
+
+```bash
+make adr-gen NUM=001 TITLE=my-adr-title
+```
 
 ## Table of Contents
diff --git a/docs/adr/adr-template.md b/docs/adr/adr-template.md