Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 2.71 KB

Contributing

Thank you for your interest in the project. We look forward to your contribution. In order to make the process as fast and streamlined as possible, here is a set of guidelines we recommend you follow.

Feature Request

Do you need a specific feature? We will develop for you.

When suggesting a feature, make sure to:

  • Check the file README.md to make sure that this feature does not exist.
  • Check existing issues, open and closed, to ensure we don't have duplicate feature requests.

To suggest a feature, open a new issue. When opening an issue, please provide the following information:

  • Title: A short, descriptive name of the feature request.
  • Description: A long description of the feature request, containing per example links to websites, blogs e technical description so that anyone can understand what youre talking about.
  • Label: Add label enhancement.

Bug Report

To start a discussion around a bug or a feature, open a new issue. When opening an issue, please provide the following information:

  • Title: A short, descriptive name of the feature request.
  • Description: Describe step by step the process or a code snippet to reproduce the bug.
  • Label: Add label bug.

Pull Request

If you've decided to fix a bug, even something as small as a single-letter typo then great! Anything that improves the code/documentation for all future users is warmly welcomed.

If you decide to work on a requested feature it's best to let us (and everyone else) know what you're working on to avoid any duplciation of effort. You can do this by replying to the original Issue for the request.

If you want to contribute an feature; go for it!

When contributing a new feature please keep your code style consistent with ours. We try to stick to the pep8 guidelines for Python https://www.python.org/dev/peps/pep-0008.

Instructions

  • Use pep8 style guidelines.
  • See other codes in this repository for more details.
  • Comment your code where necessary.
  • Submit only a single feature per pull-request.
  • Include a description of what your example is expected to do.
  • Add details of your feature to README.md.

Submitting a Pull Request

  1. Fork the repository.
  2. Create a topic branch from master.
  3. Add and commit your changes using clear messages (please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change).
  4. Push your branch to Github.
  5. Open a Pull Request on GitHub.