ADR-TOOLS

THIS REPO IS UNDER HEAVY DEVELOPMENT. CODE YOU SEE HERE IS... NOT QUITE READY OR PRETTY (yet).

This is a Typescript fork of Nat Pryce's ADR-TOOLS.

There are a few other forks out there which do some parts of the original tool but none actually do it fully.

This does.

More documentation to follow very soon!

Conventions

An ADR file MUST have a # title at the top and a ## Status header.

Local Development

yarn install

Commits

This project uses conventional commits. See conventional-commits.

There are git hooks that check the commit messages and enforce the commit rules. There is a helper tool to make it easier to create commits when unfamiliar with the rules:

yarn commit

This will use the commitlint prompt tool to help you create commits.