Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 2.12 KB
Raw

How to Contribute

This file will guide you through how to make a contribution to this project.

Did you find a bug?

If you think that you have found a bug, check this first:

  • Ensure the bug was not already reported by searching on GitHub under Issues
  • If you're unable to find an open issue addressing the problem, open a new one
  • Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
  • Tell us What went wrong?, What did you see?, What did you expect to see?, Steps to reproduce

Would you like to fix a bug?

If you would like to contibute by fixing a bug:

  • Let us know on our Slack channel that you would like fix the bug and we'll assign it to you so that everyone knows that you are working on it
  • Fork the repo, create a branch, and make your changes
  • Make sure to update or create any test cases that are required
  • Issue a Pull Request when you want to review the fix and merge it back into the project
  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.

Before Submitting An Enhancement Suggestion

  • Check the debugging guide for tips — you might discover that the enhancement is already available.
  • Check if there's already a package which provides that enhancement.
  • Determine which repository the enhancement should be suggested in.
  • Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.