Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 1.6 KB

Contributing

First off, thanks for taking the time to contribute!

How Can I Contribute?

Reporting Bugs

Bugs are tracked as GitHub issues. Create an issue and provide the following information by filling in the Bug template.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • 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.
  • Provide specific examples to demonstrate the steps.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information by filling in the Enhancement template:

  • 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.
  • Provide specific examples to demonstrate the steps.
  • Describe the current behavior and explain which behavior you expected to see instead and why.

Styleguides

Documentation Styleguide

  • Use GitHub Markdown
  • Documentation has a column limit of 80 characters (some exceptions include tables, URLs, code excerpts)
  • Use space characters for indentation (do not use tab characters)