Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ADR Template #39

Closed
MSevey opened this issue Mar 6, 2023 · 0 comments · Fixed by #40
Closed

ADR Template #39

MSevey opened this issue Mar 6, 2023 · 0 comments · Fixed by #40
Assignees
@MSevey
Labels
dependencies Pull requests that update a dependency file needs: triage
Milestone
Test

Comments

@MSevey
Copy link
Member

MSevey commented Mar 6, 2023

Overview

We need an ADR template for the org. This template should live in this repo as a reference.

Challenge

Since ADRs live in the codebase, we can't utilize things like issue templates unfortunately. We should find a solution that avoids duplicating the template in all the necessary repositories and also we could try and avoid manual copy pasting.

There is a potential solution with the use of symbolic links or git submodules, were the template is accessible from all the repos. But I can imagine that getting broken by accident pretty easily.

A simple solution would be to utilize a Makefile command and download a copy of the template.

$ make adr 001 this is my adr title
# /docs/adr/adr-001-this-is-my-adr-title.md created!
@MSevey MSevey self-assigned this Mar 6, 2023
This was referenced Mar 6, 2023
Closed
Merged
@MSevey MSevey closed this as completed in #40 Apr 5, 2023
@MSevey MSevey mentioned this issue Apr 5, 2023
Closed
2 tasks
@celestia-dev-bot celestia-dev-bot bot added this to the Test milestone Apr 5, 2023
@MSevey MSevey removed this from the Test milestone Apr 5, 2023
@celestia-dev-bot celestia-dev-bot bot added dependencies Pull requests that update a dependency file needs: triage labels Apr 5, 2023
@celestia-dev-bot celestia-dev-bot bot added this to the Test milestone Apr 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MSevey MSevey

Labels
dependencies Pull requests that update a dependency file needs: triage
Projects
None yet
Milestone
Test
Development

Successfully merging a pull request may close this issue.

copy over adr template celestiaorg/.github
1 participant
@MSevey