-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathCONTRIBUTING.md
35 lines (24 loc) · 1.24 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
34
35
# Contributing
We are grateful for any contributions made by the community. Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open-source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
## Step 1: Fork the Project
You can get your own version of this project by forking it on GitHub.
## Step 2: Create your Feature Branch
To make your own changes, create a new branch off of "main" and give it a descriptive name.
```bash
git checkout -b feature/YourFeatureName
```
## Step 3: Commit your Changes
After you have completed your changes, make sure to commit them and provide a descriptive commit message.
```bash
git commit -m 'Add some YourFeatureName'
```
## Step 4: Push to the Branch
Push your changes to your new branch on your forked repository.
```bash
git push origin feature/YourFeatureName
```
## Step 5: Open a Pull Request
Now, you can go to the original repository and open a pull request to the main branch.
Before you submit your pull request, please make sure to review the contribution guidelines and checklist:
* The changes are documented.
Thank you for your contribution!