|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +Spotted a typo? Want to improve the reference docs or even add new tutorials? That's great, we welcome all contributions to our documentation! |
| 4 | +Before you dive in, here are some things you need to know. |
| 5 | + |
| 6 | +**Table of Contents** |
| 7 | + |
| 8 | +- [Legal stuff](#legal-stuff) |
| 9 | +- [Creating your contribution](#creating-your-contribution) |
| 10 | + |
| 11 | +## Legal stuff |
| 12 | + |
| 13 | +RDF4J is a project governed by the [Eclipse Foundation](http://www.eclipse.org/), which has strict [policies and guidelines](https://wiki.eclipse.org/Development_Resources#Policies_and_Guidelines) regarding contributions. |
| 14 | + |
| 15 | +In order for any contributions to the RDF4J documentation to be accepted, you MUST do the following things: |
| 16 | + |
| 17 | +1. Digitally sign the [Eclipse Foundation Contributor License Agreement](http://www.eclipse.org/legal/CLA.php). |
| 18 | +To sign the Eclipse CLA you need to: |
| 19 | + |
| 20 | + * Obtain an Eclipse Foundation userid. If you already use Eclipse Bugzilla or Gerrit you already have one of those. If you don’t, you need to |
| 21 | +[register](https://dev.eclipse.org/site_login/createaccount.php). |
| 22 | + |
| 23 | + * Login into the [projects portal](https://projects.eclipse.org/), select “My Account”, and then the “Contributor License Agreement” tab. Read through, then sign. |
| 24 | + |
| 25 | +2. Add your github username in your Eclipse Foundation account settings. Log in it to Eclipse and go to account settings. |
| 26 | + |
| 27 | +3. "Sign-off" your commits |
| 28 | + |
| 29 | +Every commit you make in your patch or pull request MUST be "signed off". |
| 30 | +You do this by adding the `-s` flag when you make the commit(s). |
| 31 | + |
| 32 | +## Creating your contribution |
| 33 | + |
| 34 | +Once the legalities are out of the way you can dig in. Here's how: |
| 35 | + |
| 36 | +1. Fork the `rdf4j-doc` repository on GitHub. |
| 37 | +2. Create a new branch for your changes starting from the `master` branch. |
| 38 | +3. Make your changes. Please make sure you use valid [AsciiDoc syntax](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/). |
| 39 | +4. Commit your changes into the branch. Use meaningful commit messages. **Sign off** every commit you do (as explained in the [legal stuff](#legal-stuff). |
| 40 | +5. Optionally squash your commits (not necessary, but if you want to clean your commit history a bit, _this_ is the point to do it). |
| 41 | +6. Push your changes to your branch in your forked repository. |
| 42 | +7. If your contribution is complete, use GitHub to submit a pull request (PR) |
| 43 | + for your contribution back to `master` in the central rdf4j-doc repository. In the PR description, please outline |
| 44 | + what you've improved/changed and why. |
| 45 | + |
| 46 | +Once you've put up a PR, we will review your contribution, possibly make some |
| 47 | +suggestions for improvements, and once everything is complete it will be merged |
| 48 | +into the `master` branch, to be included in the update of our online documentation. |
0 commit comments