WayOfWorking::CodeOfConduct::ContributorCovenant
This is a plugin for the Way of Working framework. It uses the Contributor Covenant Code of Conduct v2.1
Using the Contributor Covenant Code of Conduct benefits any community or project by setting clear expectations for acceptable behaviour and creating a safer and more inclusive environment for everyone involved. The Code of Conduct establishes guidelines for respectful communication and conduct and consequences for inappropriate behaviour.
Installation
Install the gem and add to the application's Gemfile by executing:
bundle add way_of_working-code_of_conduct-contributor_covenant
If bundler is not being used to manage dependencies, install the gem by executing:
gem install way_of_working-code_of_conduct-contributor_covenant
Usage
To add a Contributor Covenant Code of Conduct v2.1 to your project, use the following at the command line:
way_of_working init code_of_conduct --contact-method [CONTACT METHOD]
You will need to enter a contact method, usually an email address. Please thoroughly read the enforcement guidelines section of the code and discuss the implications of adopting the code of conduct.
Development
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.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/HealthDataInsight/way_of_working-code_of_conduct-contributor_covenant. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the way_of_working-code_of_conduct-contributor_covenant project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.