Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 2.04 KB

Contributing

Bug report

When you find a bug or any other behavior that you think isn't right, you can report that to us and the community.

Submitting a bug report

To submit a bug report you can open a Issue

  • Prefix the issue with bug:
  • Use the issue template Bug report
  • Check that the bug is not already reported: Issues
  • Check that there is no fix already: Pull requests
  • Make sure that the bug is not caused by yourself or your browser settings.

Bug fix

When you fixed a bug in your local fork of this repository, you are welcome to submit it into the master branch here.
Tutorial: Creating a pull request (offical GitHub docs)
Tutorial: Comitting (readthedocs.io)

Submitting a bug fix

To submit a bug fix you can open a Pull request

  • Prefix the pull request with fix:
  • Fill the pull request template
  • Check that there is no fix already: Pull requests

Feature requests

We would love to hear feature requests!

Submitting a feature request

As issue

  • Prefix the issue with feat:
  • Use the issue template Feature request
  • Shortly explain what your feature is about
  • Describe why your feature idea is useful
  • Give a detailed description of:
    • What your feature should do
  • Check that the feature is not already requested: Issues.

As pull request

  • Prefix the pull request with feat:
  • Shortly explain what your feature is about
  • Describe why your feature idea is useful
  • Give a detailed description of:
    • What your feature will do
    • What you changed
  • Check that the feature is not already submitted: Pull requests