Skip to content

Commit 3e88707

Browse files
authored
Create CONTRIBUTING.md
1 parent 2cd7681 commit 3e88707

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CONTRIBUTING.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# How to Contribute
2+
3+
We'd love to accept your patches and contributions to this project. There are
4+
just a few small guidelines you need to follow.
5+
6+
## Code reviews
7+
8+
All submissions, including submissions by project members, require review.
9+
We use GitHub pull requests for this purpose.
10+
Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
11+
12+
## Steps to send a Pull Request
13+
1. Fork this repository to your GitHub account.
14+
2. Clone your fork to your local system using git.
15+
```shell
16+
git clone URLofYourRepository
17+
```
18+
3. Add your changes.
19+
4. Push local changes to your GitHub repository.
20+
```shell
21+
git add --all
22+
git commit -m "Short description of changes in this commit"
23+
git push origin master
24+
```
25+
5. Go to your GitHub repository. You'll see it has your changes and is some commits ahead of the original repository.
26+
6. If it is some commits behind, update your fork:
27+
```shell
28+
git fetch upstream
29+
git checkout master
30+
git merge upstream/master
31+
```
32+
Push the updated changes to your GitHub repository:
33+
```shell
34+
git push origin master
35+
```
36+
7. Go to your GitHub fork, which is some commits aheads of the original. Press `Compare` to review the changes.
37+
8. Describe the changes you want to push and send a `Pull Request`.
38+
9. Your changes will be added to the original repository once your Pull Request is reviewed and accepted.

0 commit comments

Comments
 (0)