Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 2.27 KB

CONTRIBUTE.md

File metadata and controls

37 lines (24 loc) · 2.27 KB

Contribute (WIP)

First off, thank you for taking the time to contribute!

The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

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

  • Before creating bug reports, please check the issues list as you might find out that you don't need to create one. When you are creating a bug report, include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just write what you did, but explain how you did it.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for this project, including completely new features and improvements.

  • Before creating enhancement suggestions, please check the issues list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, include as many details as possible. Fill in the required template, the information it asks for helps us resolve issues faster.
  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain, which behavior you expected to see instead and why.

Pull Requests

  • Fill in the required template.
  • Do not include issue numbers in the PR title.
  • End all files with a newline.
  • Avoid platform-dependent code.
  • Use the proper indentation, and code styling according to the project's style guide.
  • Check for unnecessary whitespace with git diff --check before committing.