Skip to content

Latest commit

 

History

History
64 lines (39 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

64 lines (39 loc) · 3.17 KB

Contributing to OpenRythm

First off, thank you for considering contributing to OpenRythm! It's people like you that make OpenRythm such a great tool.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for OpenRythm. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use the GitHub issue search — check if the issue has already been reported.
  • If the issue has not been reported, open a new issue. 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.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for OpenRythm, including completely new features and minor improvements to existing functionality.

  • Use the GitHub issue search — check if the enhancement has already been suggested.
  • If the enhancement has not been suggested, open a new issue. Be sure to include a title and clear description, as much relevant information as possible, and a rationale for the enhancement.

Your First Code Contribution

Unsure where to begin contributing to OpenRythm? You can start by looking through "good first issue" and "help wanted" issues:

  • Good first issues - issues which should only require a few lines of code and a test or two.
  • Help wanted issues - issues which should be a bit more involved than "good first issue" ones.

Pull Requests

  • Fill in the required template.
  • Do not include issue numbers in the PR title.
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the JavaScript style guide.
  • Document new code based on the JSDoc style guide.
  • End all files with a newline.
  • Avoid platform-dependent code.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

Documentation Styleguide

Use JSDoc for documenting your code.

Additional Notes

  • If you're new to contributing to open source on GitHub, this guide can help you get started.
  • If you're looking for more detailed instructions on how to contribute to OpenRythm, check out this detailed guide.

Thank you for contributing to OpenRythm!