Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
janosrusiczki committed Sep 6, 2019
1 parent 3f809e0 commit 5b5d150
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,25 +42,24 @@ matches = Underpass::QL::Query.perform(bbox, op_query)

See [more usage examples](usage-examples.md).

## Development

* Test the library by running `bundle console`
* Run `guard` in the project directory, it will run Rubocop and RSpec on the
modified files automatically

## To Do

Have a look at the [issue tracker](https://github.com/haiafara/underpass/issues).

## Contributing
## How To Contribute

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet;
* Check out the latest development branch to make sure the feature hasn't been implemented or the bug hasn't been fixed yet;
* Check out the issue tracker to make sure someone already hasn't requested it and / or contributed it;
* Fork the project;
* Fork the project, clone the fork, run `bundle install` and then make sure `rspec` runs;
* Start a feature / bugfix branch;
* Commit and push until you are happy with your contribution;
* Make sure to add specs for it. This is important so your contribution won't be broken in a future version unintentionally.

Further tips:

* To test drive the library run `bundle console`;
* Run `guard` in the project directory, it'll watch for file changes and run Rubocop and RSpec for real time feedback.

## License

underpass is released under the MIT License. See the [LICENSE file](LICENSE) for further details.

0 comments on commit 5b5d150

Please sign in to comment.