|
| 1 | +# Contributing |
| 2 | + |
| 3 | +We are always glad to receive contribution to the development of our project from the community! |
| 4 | + |
| 5 | +## Issues |
| 6 | + |
| 7 | +If you find a bug or want to suggest an improvement to support some new functionality, |
| 8 | +[create an issue](https://github.com/singnet/snet-sdk-python/issues) in the repository. |
| 9 | + |
| 10 | +### Issue must include the following information: |
| 11 | + |
| 12 | +- **Title**. Come up with a title that concisely describes the task. |
| 13 | + |
| 14 | +- **Description**. Describe the issue in as much detail as possible. If you want to implement new functionality, |
| 15 | +describe why it is useful and how it will affect the project's codebase. |
| 16 | + |
| 17 | +- **Code reference**. If this is a bug, be sure to attach the code where the error occurs and the text of the error. |
| 18 | + |
| 19 | +- **Steps to reproduce**. If this is a bug, describe the steps to reproduce the bug and in what case it occurs |
| 20 | +(here it is also advisable to add the code that you run). |
| 21 | + |
| 22 | +- **Labels**. Add the labels that describe the issue. Please refer to the |
| 23 | +[label list](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#about-default-labels) |
| 24 | +to learn more about labels. |
| 25 | + |
| 26 | +## Pull requests |
| 27 | + |
| 28 | +> Before creating a pull request, make sure there is an issue corresponding to your changes. If there isn't one, |
| 29 | +> [create one first](#issues). |
| 30 | +
|
| 31 | +If you want to implement a feature or fix a bug, fork this repository from the `master` and after all the changes |
| 32 | +[create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) |
| 33 | +to the `master` branch. Don't forget to run automated tests locally before creating a PR. |
| 34 | + |
| 35 | +### Pull request must include the following information: |
| 36 | + |
| 37 | +- **Title**. The pull request should be named after the issue number as follows: "Issue <ISSUE_NUMBER>" |
| 38 | + |
| 39 | +- **Description**. Briefly describe the feature or fix that was made. |
| 40 | + |
| 41 | +- **Changes**. Describe the main changes made in the codebase. It is advisable to insert links to the code for |
| 42 | +greater clarity. |
| 43 | + |
| 44 | +- **Interface changes**. Describe how the external interface has changed. It is advisable to insert links to |
| 45 | +the code for greater clarity. |
| 46 | + |
| 47 | + |
0 commit comments