ADR JS

Logo

Architecture Decision Records for npx.

View the Project on GitHub Virtualix-LTD/adrjs

ADRJS is a Node implementation of npryce’s adr-tools.

Many teams use a mix of operating systems, and they need to use different tools to achieve the same job.

For those teams that work with node, this package serves as a single command that can be added in devDependencies, or invoked via npx, in order to maintain a consistent experience across platforms.

Usage

Initialisation

Set a folder to store your decisions

npx adrjs init PATH

Example:

npx adrjs init docs/adr

Create a new decision

npx adrjs new TITLE

Example:

npx adrjs new We will do things this way

Amend a decision

npx adrjs -a INDEX TITLE
npx adrjs -amend INDEX TITLE
npx adrjs -amends INDEX TITLE

Example:

npx adrjs -a 13 We will do things a slightly different way

Supersede a decision

npx adrjs -s INDEX TITLE
npx adrjs -supersede INDEX TITLE
npx adrjs -supersedes INDEX TITLE

Example:

npx adrjs -s 13 We will do things a completely different way

Version

Get the tool version

npx adrjs version

Decision Records for ADRJS

Decisions taken in this project.

  1. We will use the MIT license
  2. We will not use external dependencies as much as possible
  3. We will use semantic versioning
  4. We will use ISO-8601 for dates
  5. We will make this tool compatible with the adr-tools interface in v1
  6. We will rename this tool to adrjs
  7. We will use git tags to mark releases
  8. We will use git branches to track major versions in case we ever have more than one
  9. We will keep this tool compatible with the three major operating systems
  10. We will use UTF-8 everywhere
  11. We will use Errors instead of process.exit
  12. We will adopt the Anticode Code of Conduct
  13. We will use docopt to describe our CLI options

Contributing

Visit the Issues section on this project’s Github page and open a Bug or a Feature Request. Make sure you read the Code of Conduct - it’s short and common sense. PRs are welcome. Security vulnerabilities will be announced as they become known to us.

License

The software and website are licensed under MIT. The Owl logo was found at GeekSVGs and is licensed under CC BY-SA 4.0.