From c2cc5b9b209f28881a71b417a4a7917973f47b7d Mon Sep 17 00:00:00 2001 From: Arondondon Date: Thu, 19 Jun 2025 18:58:03 +0300 Subject: [PATCH 1/2] doc: add contributing guide --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/README.md b/README.md index fa5dd4a..444ecdd 100644 --- a/README.md +++ b/README.md @@ -465,6 +465,63 @@ $ pip install -r requirements.txt $ pip install -e . ``` +## 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](https://github.com/singnet/snet-sdk-python/issues) in the repository. + +> Come up with a title that concisely describes the task. + +##### Issue must include the following information: + +- **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. + +### 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](#issues). + +If you want to implement a feature or fix a bug, fork this repository and after all the changes +[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) +to the `development` branch. + +> The pull request should be named after the issue number as follows: "Issue " + +#### Pull request must include the following information: + +- **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. + ## License This project is licensed under the MIT License - see the From ab871768dabe9e98b3fd9503f0d41bfafaa6e3a4 Mon Sep 17 00:00:00 2001 From: Arondondon Date: Fri, 20 Jun 2025 13:26:28 +0300 Subject: [PATCH 2/2] doc: change contributing guide, add CONTRIBUTING.md file --- CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++++++++ README.md | 53 +------------------------------------------------ 2 files changed, 48 insertions(+), 52 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c4f082c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# 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](https://github.com/singnet/snet-sdk-python/issues) 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](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#about-default-labels) +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](#issues). + +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](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) +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 " + +- **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. + + diff --git a/README.md b/README.md index 444ecdd..e2db2c3 100644 --- a/README.md +++ b/README.md @@ -469,58 +469,7 @@ $ pip install -e . 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](https://github.com/singnet/snet-sdk-python/issues) in the repository. - -> Come up with a title that concisely describes the task. - -##### Issue must include the following information: - -- **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. - -### 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](#issues). - -If you want to implement a feature or fix a bug, fork this repository and after all the changes -[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) -to the `development` branch. - -> The pull request should be named after the issue number as follows: "Issue " - -#### Pull request must include the following information: - -- **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. +Please refer to [Contributing guide](./CONTRIBUTING.md) ## License