Skip to content

Latest commit

 

History

History
49 lines (25 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

49 lines (25 loc) · 2.97 KB

How to get help

Do you have questions about how to use GoldenCheetah?

Do you have questions about the source code?

How to contribute to GoldenCheetah

Did you find a bug?

  • 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 steps to reproduce the problem or a test file 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.

  • See GoldenCheetah Guidelines for submitting a patch for additional information.

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 or functionality of GoldenCheetah will generally not be accepted.

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

  • Suggest your change in the golden-cheetah-developers 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 want to contribute to GoldenCheetah translations?

Do you want to contribute to GoldenCheetah documentation?

  • The GoldenCheetah wiki is open to user's contributions. feel free to add what you consider relevant to make other's users experience smoother.

GoldenCheetah is a volunteer effort. Contributions are welcome!

Thanks!

GoldenCheetah Team