Skip to content

Latest commit

 

History

History
30 lines (16 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

30 lines (16 loc) · 1.66 KB
Raw

How to contribute to Oku

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability in Oku, and instead to refer to our security policy.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number, if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Oku will generally not be accepted (read more about the rationale behind this, from the Ruby on Rails project).

Do you intend to add a new feature or change an existing one?

  • If someone hasn't already suggested the same thing, open a new issue and start writing code.

Oku is a volunteer effort. We encourage you to pitch in and join The Team!

Merci!

The Team