Skip to content
This repository has been archived by the owner on Jul 20, 2019. It is now read-only.

Latest commit

 

History

History
25 lines (16 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

25 lines (16 loc) · 1.92 KB

How To Contribute

If you find the Okra Framework useful and wish to contribute we would love to hear from you. It could be as small as submitting a feature request or bug report. Alternatively you could fix a bug or implement a new feature and send us a pull request. To keep everyone happy here are a few guidelines to follow.

Submitting feature requests

Submitting bug reports

Contributing code

If you would like to contribute code to the project then we would love to accept pull requests. A few simple guidelines to follow are,

  • For anything but the most simple changes, please add a feature request or bug report to the issue tracker stating that you would be interested in contributing. This lets the Okra Framework team and the community know you are looking into it, and starts a discussion about the best way to tackle the problem.
  • Follow a similar coding style to the existing codebase.
  • Try to keep pull requests as small as possible - it makes it a lot easier for us to review the changes before merging into the main codebase.
  • Tests need to be provided for every bug/feature that is completed, except in very special circumstances.

For more information on pull requests see GitHub - Using pull requests.