Fork me on GitHub

Contributing

So you've got an awesome idea to throw into OWNER. Great!

There are many ways to help improving OWNER:

  1. If you want to implement some change, you can fork the project on GitHub then send me a pull request. See the workflow.
  2. If you have some idea, you can submit it as change request on GitHub issues.
  3. If you've found some defect, you can submit the bug on GitHub issues.
  4. If you want to help the development, you can pick a bug or an enhancement then contribute your patches following the workflow.
  5. Also you can contribute on improving the documentation. See Updating Documentation.

And Please keep the following in mind:

  • If you're creating a small fix or patch to an existing feature, just a simple test will do. Please stay in the confines of the current test suite.
  • Also, some help on documentation would be appreciated. Documentation sources can be found on the site folder of the master branch. Great docs make a great project!
  • Please follow the project code style.
Contributions will not be accepted without tests.

Workflow

Here's the most direct way to get your work merged into the project:

  • Fork the project.
  • Clone down your fork:
git clone git://github.com/<your-username>/owner.git
  • Create a topic branch to contain your change:
git checkout -b my_awesome_feature
  • Hack away, add tests. Not necessarily in that order.
  • Make sure everything still passes by running mvn test.
  • If necessary, rebase your commits into logical chunks, without errors.
  • Push the branch up:
git push origin my_awesome_feature
  • Create a pull request against lviggiano/owner and describe what your change does and the why you think it should be merged.

Updating Documentation

We want the OWNER documentation to be the best it can be. We've open-sourced our docs and we welcome any pull requests if you find it lacking.

You can find the documentation for owner.aeonbits.org in the site folder of the master branch.

All documentation pull requests should be directed at master. Pull requests directed at another branch will not be accepted.

The OWNER wiki on GitHub can be freely updated without a pull request as all GitHub users have read and write access.