Skip to content

Commit

Permalink
Make use of the common adr template in the .github repo (#1599)
Browse files Browse the repository at this point in the history
<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview

<!-- 
Please provide an explanation of the PR, including the appropriate
context,
background, goal, and rationale. If there is an issue with this
information,
please provide a tl;dr and link the issue. 
-->

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:     https://asciinema.org/a/56X6g1bA9NpWq0FxW8wDMRJ3g

Closes #1415 

## Checklist

<!-- 
Please complete the checklist to ensure that the PR is ready to be
reviewed.

IMPORTANT:
PRs should be left in Draft until the below checklist is completed.
-->

- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [x] Visual proof for any user facing features like CLI or
documentation updates
- [x] Linked issues closed with keywords

---------

Co-authored-by: Evan Forbes <[email protected]>
Co-authored-by: Rootul P <[email protected]>
  • Loading branch information
3 people authored Apr 17, 2023
1 parent 0bdfa07 commit 7d06f53
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 75 deletions.
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,9 @@ test-cover:
@echo "--> Generating coverage.txt"
@export VERSION=$(VERSION); bash -x scripts/test_cover.sh
.PHONY: test-cover

## adr-gen: Download the ADR template from the celestiaorg/.github repo. Ex. `make adr-gen NUM=016 TITLE=my-adr-title`
adr-gen:
@echo "--> Generating ADR template"
@curl -sSL https://raw.githubusercontent.com/celestiaorg/.github/main/adr-template.md > docs/architecture/adr-$(NUM)-$(TITLE).md
.PHONY: adr-gen
75 changes: 0 additions & 75 deletions docs/architecture/adr-template.md

This file was deleted.

0 comments on commit 7d06f53

Please sign in to comment.