Skip to content

Commit fe44d2d

Browse files
authored
Create CONTRIBUTING.md
1 parent 0b77508 commit fe44d2d

1 file changed

Lines changed: 75 additions & 0 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributing
2+
3+
## Request for changes/ Pull Requests
4+
You first need to create a fork of the [effectsize][effectsize] repository to commit your changes to it. Methods to fork a repository can be found in the [GitHub Documentation][fork].
5+
6+
Then add your fork as a local project:
7+
8+
```sh
9+
# Using HTTPS
10+
git clone https://github.com/nbashir97/effectsize.git
11+
12+
# Using SSH
13+
git clone git@github.com:nbashir97/effectsize
14+
```
15+
16+
> [Which remote URL should be used ?][remote]
17+
18+
Then, go to your local folder
19+
20+
```sh
21+
cd effectsize
22+
```
23+
24+
Add git remote controls :
25+
26+
```sh
27+
# Using HTTPS
28+
git remote add fork https://github.com/YOUR-USERNAME/effectsize.git
29+
git remote add upstream https://github.com/nbashir97/effectsize.git
30+
31+
32+
# Using SSH
33+
git remote add fork git@github.com:YOUR-USERNAME/effectsize.git
34+
git remote add upstream git@github.com/nbashir97/effectsize.git
35+
```
36+
37+
You can now verify that you have your two git remotes:
38+
39+
```sh
40+
git remote -v
41+
```
42+
43+
## Receive remote updates
44+
In view of staying up to date with the central repository :
45+
46+
```sh
47+
git pull upstream master
48+
```
49+
50+
## Choose a base branch
51+
Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use master.
52+
53+
| Type of change | | Branches |
54+
| :------------------ |:---------:| ---------------------:|
55+
| Documentation | | `master` |
56+
| Bug fixes | | `master` |
57+
| New features | | `master` |
58+
| New issues models | | `YOUR-USERNAME:patch` |
59+
60+
```sh
61+
# Switch to the desired branch
62+
git switch master
63+
64+
# Pull down any upstream changes
65+
git pull
66+
67+
# Create a new branch to work on
68+
git switch --create patch/1234-name-issue
69+
```
70+
71+
Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the effectsize repository][effectsize] following the template provided.
72+
73+
[effectsize]: https://github.com/nbashir97/effectsize
74+
[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
75+
[remote]: https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories

0 commit comments

Comments
 (0)