Skip to content

Conversation

@jhoward-lm
Copy link
Contributor

@jhoward-lm jhoward-lm commented Jun 24, 2024

Add architecture decision record template and VSCode snippet

Description

Initialize the ADR process for documenting history for future architecture decisions. This PR adds a template for use with adr-tools as well as a VSCode snippet to easily generate ADR documents.

Type of change

  • Documentation/process

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Signed-off-by: Jonathan Howard <jonathan.w.howard@lmco.com>
@jhoward-lm jhoward-lm added the documentation Improvements or additions to documentation label Jun 24, 2024
@jhoward-lm jhoward-lm self-assigned this Jun 24, 2024
@jhoward-lm jhoward-lm requested a review from a team as a code owner June 24, 2024 18:58
@idunbarh
Copy link
Member

I see a couple tools that could be adr-tools. Are you referring to this one? - https://github.com/npryce/adr-tools

@jhoward-lm
Copy link
Contributor Author

jhoward-lm commented Jun 24, 2024

I see a couple tools that could be adr-tools. Are you referring to this one? - https://github.com/npryce/adr-tools

Yes, I put the links in the new README.md, as well as in comments in the ADR template and snippet generated template.

@idunbarh idunbarh merged commit 9b27964 into main Jun 25, 2024
@jhoward-lm jhoward-lm deleted the arch-decision-records branch June 25, 2024 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants