Skip to content

Latest commit

 

History

History
38 lines (20 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

38 lines (20 loc) · 1.87 KB
Raw

How to contribute to Gekko

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability in Gekko, and instead contact [email protected].

  • 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 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 Gekko will generally not be accepted.

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

  • Suggest your change in the APMonitor mailing list and start writing code.

  • Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Do you have questions about the source code?

Do you want to contribute to the Gekko documentation?

Gekko is a volunteer effort. We encourage you to pitch in and join the team!

Thanks!

Gekko Team