-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathCONTRIBUTING.md
33 lines (21 loc) · 1.07 KB
/
CONTRIBUTING.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# How to contribute
## Fork the project
Fork the project to your GitHub account and clone it to your machine.
## Create a branch for your contribution
Create a branch with a meaningful name for your contribution.
**Hints:**
- say you want to add a new feature, then you can create a branch with the name feature/new-function.
- say you want to fix a bug, then you can create a branch named bug/correct-bug.
- say you want to improve the documentation, then you can create a branch named docs/improve-documentation.
## Opening an issue
You should normally open an issue in the following situations:
- Report a bug that.
- Discussing a high-level topic or idea (for example, community, vision or policies)
- Propose a new feature or other project idea.
> If you open an issue to report a bug, please include as much detail as possible.
## Submitting a pull request
You should normally submit a pull request in the following situations:
- Fixing a bug.
- Add a new feature.
- Improve the documentation.
> If you send a pull request to fix a bug, please include as much detail as possible.