Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
msimonborg committed Aug 6, 2017
1 parent 3c145a4 commit f03cf5a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,14 +106,28 @@ Tested against:

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
After checking out the repo, run `bin/setup` to install dependencies. The manual steps are:

$ bundle install
$ bundle exec appraisal install

Run `bin/console` for an IRB session with all dependencies loaded.

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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/msimonborg/allowable.

Steps to contribute

* Write new tests that describe the desired behavior, or catch regressions. PRs won't be approved without test coverage
* Write your code
* Run build task with `bundle exec rake`, make sure all tests pass and there are no Rubocop issues
* Run `bundle exec appraisal rake` to run tests against different Rails versions
* Add documentation to README.md if appropriate and necessary
* Commit with a descriptive message
* Submit a PR

## License

Expand Down
1 change: 1 addition & 0 deletions bin/setup
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ IFS=$'\n\t'
set -vx

bundle install
bundle exec appraisal install

# Do any other automated setup that you need to do here

0 comments on commit f03cf5a

Please sign in to comment.