Skip to content

README.md

Latest commit

 

History

History
23 lines (15 loc) · 1.08 KB

README.md

File metadata and controls

23 lines (15 loc) · 1.08 KB

Architecture Decision Records

Create a new ADR

For new ADRs, the status should be Proposed. Use one of the following methods to automatically generate a markdown document for the ADR.

adr-tools

  1. Install adr-tools
  2. Run adr new <title of new ADR as it should appear in documentation>
  3. Open the new file that was generated in this directory
  4. Update the placeholder text in the new file to provide information for all required fields

VSCode Snippet

  1. Create a new markdown file in this directory. The file should follow the naming format NNNN-lowercase-title-with-dashes.md
  2. Open the file in a VSCode editor
  3. Type adr and select it from the editor suggestions (may need to show suggestions with CTRL + space or command + space)
  4. Use tab to navigate through the fields requiring input and update the placeholder text

Submit ADR

Follow the steps outlined in CONTRIBUTING.md to create a pull request that adds the new ADR file to the repository.