Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 2.09 KB

Contributing

We are always glad to receive contribution to the development of our project from the community!

Issues

If you find a bug or want to suggest an improvement to support some new functionality, create an issue in the repository.

Issue must include the following information:

  • Title. Come up with a title that concisely describes the task.

  • Description. Describe the issue in as much detail as possible. If you want to implement new functionality, describe why it is useful and how it will affect the project's codebase.

  • Code reference. If this is a bug, be sure to attach the code where the error occurs and the text of the error.

  • Steps to reproduce. If this is a bug, describe the steps to reproduce the bug and in what case it occurs (here it is also advisable to add the code that you run).

  • Labels. Add the labels that describe the issue. Please refer to the label list to learn more about labels.

Pull requests

Before creating a pull request, make sure there is an issue corresponding to your changes. If there isn't one, create one first.

If you want to implement a feature or fix a bug, fork this repository from the master and after all the changes create a pull request to the master branch. Don't forget to run automated tests locally before creating a PR.

Pull request must include the following information:

  • Title. The pull request should be named after the issue number as follows: "Issue <ISSUE_NUMBER>"

  • Description. Briefly describe the feature or fix that was made.

  • Changes. Describe the main changes made in the codebase. It is advisable to insert links to the code for greater clarity.

  • Interface changes. Describe how the external interface has changed. It is advisable to insert links to the code for greater clarity.