From 4336323852f7c232dbb4b94c53bc6edfc7d003dc Mon Sep 17 00:00:00 2001 From: Geoffrey Pruvost Date: Wed, 31 Mar 2021 12:04:06 +0200 Subject: [PATCH 1/3] update community guidelines --- CONTRIBUTING.md | 22 +++++++++++++++++++--- README.md | 7 +++++++ 2 files changed, 26 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9a1489c..35006ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,13 +3,29 @@ When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. -Please note we have a code of conduct, please follow it in all your interactions with the project. +Please note we have [a code of conduct](https://github.com/moead-framework/framework/blob/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. -## Pull Request Process + +## You want to share a bug or an idea ? + +You can [create an issue](https://github.com/moead-framework/framework/issues/new) with all information that can +help us to understand your request. If you want to report a bug, share with us the following information: + +- version of python +- version of the framework +- operating system +- the error raised by your code +- all steps to reproduce the bug + + +## You want to contribute to the framework code ? + +You can [create an issue](https://github.com/moead-framework/framework/issues/new) with information about the feature or the change you want to make. +You can then create a Pull Request with the following process : 1. Update the README.md with details of changes to the interface, this includes new environment variables and useful file locations. -2. Update the documentation with a new Pull Request on this repository [https://github.com/moead-framework/framework/tree/master/docs](https://github.com/moead-framework/framework/tree/master/docs). +2. Update the documentation available in the folder [https://github.com/moead-framework/framework/tree/master/docs](https://github.com/moead-framework/framework/tree/master/docs). 3. Don't forget to add unit tests. 4. Create a new branch and a Pull Request to merge your work on the **dev** branch of the project. diff --git a/README.md b/README.md index b72fd0b..4bd09f4 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,13 @@ The package is available in pypi with a linux environment for python 3.6, 3.7, 3 save_population(save_file, population) +# How to contribute + +[A guide is available](https://github.com/moead-framework/framework/blob/master/CONTRIBUTING.md) to explain the +process of contributing to the project. The contribution can be the report of a bug, the request for a new feature or +modifying the code of the framework to improve it. + +We have [a code of conduct](https://github.com/moead-framework/framework/blob/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. # For developers From 4e3eedcf01623a28562894613de40bc5e5f318b5 Mon Sep 17 00:00:00 2001 From: Geoffrey Pruvost Date: Fri, 9 Apr 2021 09:57:45 +0200 Subject: [PATCH 2/3] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..b65c361 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Call the function '....' +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. Windows 10] + - Python [e.g. 3.5, 3.6, ...] + - Version [e.g. 0.5.7] + + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From e979f6f2d663dc244a8144dcd7781779bd8ac787 Mon Sep 17 00:00:00 2001 From: Geoffrey Pruvost Date: Fri, 9 Apr 2021 10:12:15 +0200 Subject: [PATCH 3/3] add a section related to GitHub Discussions --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35006ab..d4ff809 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,12 @@ You can then create a Pull Request with the following process : 3. Don't forget to add unit tests. 4. Create a new branch and a Pull Request to merge your work on the **dev** branch of the project. +## You want to discuss the project ? + +If you have any questions about the project, don't hesitate to create a [new discussion](https://github.com/moead-framework/framework/discussions/new) +with the [GitHub Discussions](https://github.com/moead-framework/framework/discussions). It is the space for your community to have conversations, +ask questions and post answers without opening issues. + ## Code of Conduct The code of conduct is available [in this file](https://github.com/moead-framework/framework/blob/master/CODE_OF_CONDUCT.md).