Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.47 KB

How to contribute

Found a bug in the code, or have an idea for a feature?
Here are some notes on how to best report them so we can get it fixed as quickly as possible.

New Features

Here is a quick guideline on how to request a new feature:

  • Open up a new issue and try to be as detailed as possible.
  • Try describing it as a story - Here is a How To
  • Optionally, if you can provide a mock up that would be great too.
  • Pull Requests are also very much welcome.

Issues

Found a bug?

While raising an issue please provide the following info below.

  • Explain, as detailed as possible, how to reproduce the issue / bug.
  • Include what you expected to happen, as well as what actually happened and logs.
  • Provide your environment details; OS, PyCharm Version, Python and Modules Version
  • If it helps, feel free to attach a screenshot or video illustrating the issue.

Pull Requests

Know how to fix something? Create a pull request! Here's a quick guide:

  • Check for open issues, or open a fresh issue to start a discussion around a feature idea or a bug.
  • Fork the relevant repository on GitHub, and start making your changes.
  • Push the change (please use a separate branch for your feature).
  • Open a pull request.
  • I will try to merge and deploy changes as soon as possible, or at least leave some feedback, but if you haven't heard anything after a couple of days, feel free to leave a comment on the pull request.