Skip to content

Commit

Permalink
Merge pull request #52 from geoffreyp/issue-13-communityguidelines
Browse files Browse the repository at this point in the history
update community guidelines
  • Loading branch information
geoffreyp authored Apr 14, 2021
2 parents 45ec4eb + e979f6f commit 4988957
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 3 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
28 changes: 25 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,38 @@
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.

## 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).
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,13 @@ save_file = "moead-rmnk" + str(rmnk.number_of_objective) \
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

Expand Down

0 comments on commit 4988957

Please sign in to comment.