Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.38 KB

Contributors guide

Submitting bugs

Before submitting a bug, please do the following:

  • Make sure you’re on the latest version. If you’re not on the most recent version, your problem may have been solved already! Upgrading is always the best first step.
  • Search the project’s bug/issue tracker to make sure it’s not a known issue.

If you don’t find a pre-existing issue you are free to create new one just please make sure you have added as much details as possible:

  • Be clear about what your problem is: what was the expected outcome, what happened instead? Detail how someone else can recreate the problem.
  • Paste error output or logs with proper formatting (i.e. wrapping in three backticks ```)
  • Include system details like what the browser, library or operating system you’re using and its version.

Contributing

If you’re able to patch the bug or add the feature yourself – fantastic, make a pull request with the code!

Contributing Check List

TODO

  • it would be nice to squash commits before creating pull requests
  • it's required to squash commits before merge

Commit message format

resolve #<issue number> | <commit message>

i.e. resolve #123 | my commit message

You can also use other magic words from GitHub handbook.

Coding style

TODO