|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +Community contributions are essential for keeping Ruby RDF great. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. |
| 4 | + |
| 5 | +## Development |
| 6 | + |
| 7 | +This repository uses [Git Flow](https://github.com/nvie/gitflow) to manage development and release activity. All submissions _must_ be on a feature branch based on the _develop_ branch to ease staging and integration. |
| 8 | + |
| 9 | +* create or respond to an issue on the [Github Repository](http://github.com/ruby-rdf/sparql-client/issues) |
| 10 | +* Fork and clone the repo: |
| 11 | + `git clone [email protected]:your-username/sparql-client.git` |
| 12 | +* Install bundle: |
| 13 | + `bundle install` |
| 14 | +* Create tests in RSpec and make sure you achieve at least 90% code coverage for the feature your adding or behavior being modified. |
| 15 | +* Push to your fork and [submit a pull request][pr]. |
| 16 | + |
| 17 | +## Do's and Dont's |
| 18 | +* Do your best to adhere to the existing coding conventions and idioms. |
| 19 | +* Don't use hard tabs, and don't leave trailing whitespace on any line. |
| 20 | + Before committing, run `git diff --check` to make sure of this. |
| 21 | +* Do document every method you add using [YARD][] annotations. Read the |
| 22 | + [tutorial][YARD-GS] or just look at the existing code for examples. |
| 23 | +* Don't touch the `.gemspec` or `VERSION` files. If you need to change them, |
| 24 | + do so on your private branch only. |
| 25 | +* Do feel free to add yourself to the `CREDITS` file and the |
| 26 | + corresponding list in the the `README`. Alphabetical order applies. |
| 27 | +* Don't touch the `AUTHORS` file. If your contributions are significant |
| 28 | + enough, be assured we will eventually add you in there. |
| 29 | +* Do note that in order for us to merge any non-trivial changes (as a rule |
| 30 | + of thumb, additions larger than about 15 lines of code), we need an |
| 31 | + explicit [public domain dedication][PDD] on record from you. |
| 32 | + |
| 33 | +[YARD]: http://yardoc.org/ |
| 34 | +[YARD-GS]: http://rubydoc.info/docs/yard/file/docs/GettingStarted.md |
| 35 | +[PDD]: http://lists.w3.org/Archives/Public/public-rdf-ruby/2010May/0013.html |
| 36 | +[pr]: https://github.com/ruby-rdf/sparql-client/compare/ |
0 commit comments