epic-stack
epic-stack copied to clipboard
(docs) update adr template
Summary
This PR encompasses two main changes. First, an ADR (Architecture Decision Record) has been created for the ADR itself. Second, the build steps have been automated to generate an index file.
Test Plan
To validate the changes, please follow these steps:
- Switch to the
mainbranch:git checkout main - Fetch the latest changes:
git fetch - Merge the
epic-stack:docs/update-adr-templatebranch:git merge epic-stack:docs/update-adr-template - Switch to the
feat/proposalbranch:git checkout feat/proposal - Copy the
adr-template.mdfile into the decisions directory using the following filename format:NNNN-title-with-dashes.md, whereNNNNrepresents the next sequential number. For example:cp docs/adr-template.md docs/decisions/0001-title-with-dashes.md - Edit the
NNNN-title-with-dashes.mdfile as needed. - Update the
index.mdfile with:yarn adr:update
Once you have completed these steps, verify that the index.md file in the docs/decisions directory has been successfully updated with the newly created ADR.
Platform update
- [x] Node Dependencies - bumping versions or adding a new dependency