From 5b5d15086160ab3a40cbf48e625b7fe1ffbe4b61 Mon Sep 17 00:00:00 2001 From: Janos Rusiczki Date: Fri, 6 Sep 2019 14:03:32 +0300 Subject: [PATCH] Improve README --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d1e3dfa..ab7adc4 100644 --- a/README.md +++ b/README.md @@ -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.