https://github.com/andrewmcodes-archive/contributor_covenant
https://github.com/andrewmcodes-archive/contributor_covenant
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/andrewmcodes-archive/contributor_covenant
- Owner: andrewmcodes-archive
- License: mit
- Created: 2018-12-27T14:15:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-12-27T17:00:34.000Z (over 6 years ago)
- Last Synced: 2025-02-04T03:25:51.458Z (4 months ago)
- Language: Ruby
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# contributor_covenant
## :warning: This gem is under very active development is by no means bug-free :warning:
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'contributor_covenant'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install contributor_covenant
## Usage
Generate Coraline Ada Ehmke's [Contributor Covenant](https://www.contributor-covenant.org/) at the root of your project. Simply install the gem and either add to your gemfile (but why would you??) or run the following in your terminal:
```sh
contributor-covenant
```
## 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`.
## Release
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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/contributor_covenant.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).