Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

45 lines (26 loc) · 1.89 KB

Contributing

First off, thanks for taking the time to contribute! This is really important to help us improve the library.

Report bugs

Bugs are reported using GitHub issues.

Before creating a new issue, check if your bug hasn't already been reported. If it's the case and you don't find a solution in the comments, contribute to the issue instead of creating a new one.

Submit a (good) bug report

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

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps. Include links to files or projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.

Go to issues

Suggest changes

Enhancement suggestions are tracked as GitHub issues.

To create enhancement suggestions, create a new issue.

Code contribution

You can look for issues labelled with help-wanted if you're not sure where to start!

Commit guidelines

Look at the previous commits for inspiration! But you need it to be explicit, and it should follow these rules:

  • Write it in English
  • Start with an emoji from gitmoji corresponding to the changes made
  • Do not end the subject line with a period
  • Capitalize the subject line
  • Use the imperative mood

Pull requests

When creating a pull request, follow and complete the provided template.