celestiaorg ADR template #1415
Labels
documentation
Improvements or additions to documentation
Comments
Merged
rootulp
added a commit
that referenced
this issue
Feb 22, 2023
Addresses #1161 (comment) ## Questions 1. Do we want to make the same change across other celestiaorg repos? 2. Should we consider an org wide ADR template? 1. #1415
|
Created celestiaorg/.github#39 |
5 tasks
This was referenced Apr 5, 2023
Wondertan
added a commit
to celestiaorg/celestia-node
that referenced
this issue
Apr 13, 2023
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 <hlibwondertan@gmail.com>
rootulp
added a commit
that referenced
this issue
Apr 17, 2023
<!-- 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 <42654277+evan-forbes@users.noreply.github.com> Co-authored-by: Rootul P <rootulp@gmail.com>
0xchainlover
pushed a commit
to celestia-org/celestia-app
that referenced
this issue
Aug 1, 2024
Addresses celestiaorg/celestia-app#1161 (comment) ## Questions 1. Do we want to make the same change across other celestiaorg repos? 2. Should we consider an org wide ADR template? 1. celestiaorg/celestia-app#1415
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Context
celestia-app made a small change to the ADR template in #1407 so the ADR template in celestia-app differs from other celestiaorg repos.
Proposal
Establish an org wide ADR template. If an org wide template is created, here are some proposed modifications:
Alternatives
Preserve the existing ADR templates (one per repo). If we want consistency across the org, re-apply changes to all ADR templates. If consistency isn't necessary, let individual teams decide what belongs in their ADR template.
Notes
The canonical ADR template likely should not live in celestia-app and should instead live in a different celestiaorg repo. This issue exists in celestia-app because a suitable org wide repo could not be found (cc @MSevey).
The text was updated successfully, but these errors were encountered: