-
Notifications
You must be signed in to change notification settings - Fork 14
feat: enhance ADR templates with multiple variants and configuration support #13
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| ### {{ADR_NUMBER}}-{{ADR_TITLE}} | ||
|
|
||
| **Status:** Proposed | ||
|
|
||
| **Date:** {{DATE}} | ||
|
|
||
| **Authors:** {{AUTHORS}} | ||
|
|
||
| **Stakeholders:** {{STAKEHOLDERS}} | ||
|
|
||
| ## Problem Statement | ||
|
|
||
| {{PROBLEM_STATEMENT}} | ||
| [What problem are we trying to solve? What is the current situation that needs to change?] | ||
|
|
||
| ## Context | ||
|
|
||
| {{CONTEXT}} | ||
| [Describe the forces at play, including technological, political, social, and project local. What are the business requirements and constraints?] | ||
|
|
||
| ## Assumptions | ||
|
|
||
| {{ASSUMPTIONS}} | ||
| [List any assumptions being made that could affect this decision] | ||
|
|
||
| ## Options Considered | ||
|
|
||
| ### Option 1: {{OPTION_1_NAME}} | ||
|
|
||
| **Description:** [Brief description of the option] | ||
| **Pros:** | ||
|
|
||
| - [List advantages] | ||
|
|
||
| **Cons:** | ||
|
|
||
| - [List disadvantages] | ||
|
|
||
| **Implementation Effort:** [High/Medium/Low] | ||
|
|
||
| ### Option 2: {{OPTION_2_NAME}} | ||
|
|
||
| **Description:** [Brief description of the option] | ||
| **Pros:** | ||
|
|
||
| - [List advantages] | ||
|
|
||
| **Cons:** | ||
|
|
||
| - [List disadvantages] | ||
|
|
||
| **Implementation Effort:** [High/Medium/Low] | ||
|
|
||
| ### Option 3: {{OPTION_3_NAME}} | ||
|
|
||
| **Description:** [Brief description of the option] | ||
| **Pros:** | ||
|
|
||
| - [List advantages] | ||
|
|
||
| **Cons:** | ||
|
|
||
| - [List disadvantages] | ||
|
|
||
| **Implementation Effort:** [High/Medium/Low] | ||
|
|
||
| ## Decision | ||
|
|
||
| {{DECISION}} | ||
| [Describe the chosen solution and explain why it was selected over the alternatives. Include the rationale behind the decision.] | ||
|
|
||
| ## Rationale | ||
|
|
||
| {{RATIONALE}} | ||
| [Provide detailed reasoning for why this decision was made, including trade-offs considered] | ||
|
|
||
| ## Consequences | ||
|
|
||
| ### Positive Consequences | ||
|
|
||
| {{POSITIVE_CONSEQUENCES}} | ||
|
|
||
| - [List expected benefits and improvements] | ||
|
|
||
| ### Negative Consequences | ||
|
|
||
| {{NEGATIVE_CONSEQUENCES}} | ||
|
|
||
| - [List potential drawbacks or challenges] | ||
|
|
||
| ### Neutral Consequences | ||
|
|
||
| {{NEUTRAL_CONSEQUENCES}} | ||
|
|
||
| - [List other impacts that are neither clearly positive nor negative] | ||
|
|
||
| ## Implementation Plan | ||
|
|
||
| {{IMPLEMENTATION_PLAN}} | ||
| [High-level steps needed to implement this decision] | ||
|
|
||
| 1. [Step 1] | ||
| 2. [Step 2] | ||
| 3. [Step 3] | ||
|
|
||
| ## Success Metrics | ||
|
|
||
| {{SUCCESS_METRICS}} | ||
| [How will we measure the success of this decision?] | ||
|
|
||
| ## Dependencies | ||
|
|
||
| {{DEPENDENCIES}} | ||
| [List any dependencies on other ADRs, systems, or external factors] | ||
|
|
||
| ## Risks and Mitigation | ||
|
|
||
| {{RISKS_AND_MITIGATION}} | ||
| [Identify potential risks and how they will be mitigated] | ||
|
|
||
| ## Future Considerations | ||
|
|
||
| {{FUTURE_CONSIDERATIONS}} | ||
| [What might we need to revisit in the future? What could change our decision?] | ||
|
|
||
| ## Related ADRs | ||
|
|
||
| {{RELATED_ADRS}} | ||
| [List any related or superseded ADRs] | ||
|
|
||
| ## References | ||
|
|
||
| {{REFERENCES}} | ||
| [Include links to relevant documentation, research, or external resources] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| ### {{ADR_NUMBER}}-{{ADR_TITLE}} | ||
|
|
||
| **Status:** Proposed | ||
|
|
||
| **Date:** {{DATE}} | ||
|
|
||
| ## Problem | ||
|
|
||
| {{PROBLEM}} | ||
| [What problem are we trying to solve?] | ||
|
|
||
| ## Decision | ||
|
|
||
| {{DECISION}} | ||
| [What solution did we choose and why?] | ||
|
|
||
| ## Alternatives Considered | ||
|
|
||
| {{ALTERNATIVES}} | ||
| [What other options were considered? Why were they rejected?] | ||
|
|
||
| ## Consequences | ||
|
|
||
| {{CONSEQUENCES}} | ||
| [What are the positive and negative outcomes of this decision?] | ||
|
|
||
| ## Notes | ||
|
|
||
| {{NOTES}} | ||
| [Any additional context, implementation details, or future considerations] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| ### {{ADR_NUMBER}}-{{ADR_TITLE}} | ||
|
|
||
| - **Status:** Proposed | ||
| - **Date:** {{DATE}} | ||
| - **Deciders:** {{DECIDERS}} | ||
| - **Technical Story:** {{TECHNICAL_STORY}} | ||
|
|
||
| ## Context and Problem Statement | ||
|
|
||
| {{CONTEXT_AND_PROBLEM_STATEMENT}} | ||
|
|
||
| [Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.] | ||
|
|
||
| ## Decision Drivers | ||
|
|
||
| {{DECISION_DRIVERS}} | ||
|
|
||
| [List the factors that influence the decision] | ||
|
|
||
| - [driver 1, e.g., a force, facing concern, ...] | ||
| - [driver 2, e.g., a force, facing concern, ...] | ||
| - [driver 3, e.g., a force, facing concern, ...] | ||
|
|
||
| ## Considered Options | ||
|
|
||
| {{CONSIDERED_OPTIONS}} | ||
|
|
||
| [List the options that were considered] | ||
|
|
||
| - [option 1] | ||
| - [option 2] | ||
| - [option 3] | ||
|
|
||
| ## Decision Outcome | ||
|
|
||
| **Chosen option:** {{CHOSEN_OPTION}} | ||
|
|
||
| [Justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force | ... | comes out best (see below).] | ||
|
|
||
| ### Positive Consequences | ||
|
|
||
| {{POSITIVE_CONSEQUENCES}} | ||
|
|
||
| - [e.g., improvement of quality attribute satisfaction, follow-up decisions required, ...] | ||
| - ... | ||
|
|
||
| ### Negative Consequences | ||
|
|
||
| {{NEGATIVE_CONSEQUENCES}} | ||
|
|
||
| - [e.g., compromising quality attribute, follow-up decisions required, ...] | ||
| - ... | ||
|
|
||
| ## Pros and Cons of the Options | ||
|
|
||
| ### {{OPTION_1_NAME}} | ||
|
|
||
| {{OPTION_1_DESCRIPTION}} | ||
|
|
||
| [example | description | pointer to more information | ...] | ||
|
|
||
| - Good, because [argument a] | ||
| - Good, because [argument b] | ||
| - Bad, because [argument c] | ||
| - ... | ||
|
|
||
| ### {{OPTION_2_NAME}} | ||
|
|
||
| {{OPTION_2_DESCRIPTION}} | ||
|
|
||
| [example | description | pointer to more information | ...] | ||
|
|
||
| - Good, because [argument a] | ||
| - Good, because [argument b] | ||
| - Bad, because [argument c] | ||
| - ... | ||
|
|
||
| ### {{OPTION_3_NAME}} | ||
|
|
||
| {{OPTION_3_DESCRIPTION}} | ||
|
|
||
| [example | description | pointer to more information | ...] | ||
|
|
||
| - Good, because [argument a] | ||
| - Good, because [argument b] | ||
| - Bad, because [argument c] | ||
| - ... | ||
|
|
||
| ## Links | ||
|
|
||
| {{LINKS}} | ||
|
|
||
| [Link type] [Link to ADR] <!-- example: Refined by [ADR-0005](0005-example.md) --> | ||
| [Link type] [Link to ADR] <!-- example: Superseded by [ADR-0010](0010-example.md) --> | ||
|
|
||
| - [Link type] [Link to documentation] | ||
| - [Link type] [Link to external resource] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The top-level metadata lines here use bullet markers, but other ADR templates use inline metadata (no leading dash). For consistency, consider removing the
-prefix so all templates format metadata the same way.