Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.57 KB

Contributing

First off, thanks for taking the time to contribute!

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

Table Of Contents

  1. Code of Conduct
  2. Styleguides

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Styleguides

Code

  • Try to write your code following the style in the repo already.

Issues

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a comprehensive description of the suggested enhancement in as much detail as possible.
  • (If applicable) Provide specific examples to demonstrate the steps. Include code snippets which you use in those examples, as Markdown code blocks.

Commit Messages

  • Limit the first line to 72 characters or less
  • Reference issues and pull requests

Pull Requests

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Include any relevant issue numbers in the PR body, not the title.
  • Provide a comprehensive description of all changes made.