Simple cli tool to generate ADR (architecture decision records) notes
MIT License
This gem gives you a simple too to generate adr files as markdown https://github.com/joelparkerhenderson/architecture_decision_record.
Add this line to your application's Gemfile:
group :development do
# ...
gem 'rladr'
end
And then execute:
$ bundle
Or install it yourself as:
$ gem install rladr
First you need to initialize the directory where ards will be stored
$ rladr init [directory]
Then create your adrs
$ rladr new <title>
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
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 tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/andrewaguiar/rladr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Rladr project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.