WayOfWorking::DecisionRecord::Madr

This is a plugin for the Way of Working framework. It uses Markdown Any Decision Records (MADR) version 3.0.0 to capture key technical (e.g archtectural) and non-technical decisions within your repository.

You can read about the general approach to capturing decisions on the GDS Way page on Architecture Decisions and specifics about MADR are available at https://adr.github.io/madr/.

Install the gem and add to the application's Gemfile by executing:

bundle add way_of_working-decision_record-madr

If bundler is not being used to manage dependencies, install the gem by executing:

gem install way_of_working-decision_record-madr

To add the Markdown Any Decision Records (MADR) v3.0.0 framework to your project, run the following at the command line:

way_of_working init decision_record

To create a new decision record, run:

way_of_working new decision_record [NAME]

Where [NAME] is the title of your decision record, for example:

way_of_working new decision_record "Use Markdown Any Decision Records"

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/HealthDataInsight/way_of_working-decision_record-madr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the WayOfWorking::DecisionRecord::Madr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.