Skip to content

Commit 68ba4a1

Browse files
Update CONTRIBUTING.md for branch name change master -> main (#90)
Hi @HDembinski. I noticed this while looking around yesterday. Trivial but nice to get it updated :).
1 parent f1cd42b commit 68ba4a1

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,30 @@ Now `cd` to the project folder (the rest assumes you are in the project folder).
1010
```
1111
git submodule update --init
1212
```
13-
Add a remote endpoint called *upstream* to keep in sync with the master of the scikit-hep repository:
13+
Add a remote endpoint called *upstream* to keep in sync with the main of the scikit-hep repository:
1414
```
1515
git remote add upstream https://github.com/scikit-hep/pyhepmc.git
1616
```
1717
This concludes the initial set up.
1818

19-
To develop a feature or a fix, create a branch from your master (make sure your master is in sync with the scikit-hep master):
19+
To develop a feature or a fix, create a branch from your main (make sure your main is in sync with the scikit-hep main):
2020
```
21-
git checkout -b my_cool_feature master
21+
git checkout -b my_cool_feature main
2222
```
23-
Commit to your branch and initiate a pull request from the Github web page when you feel the feature is ready to be reviewed. Note: Never commit to the master, only to feature branches.
23+
Commit to your branch and initiate a pull request from the Github web page when you feel the feature is ready to be reviewed. Note: Never commit to the main, only to feature branches.
2424

25-
The scikit-hep master may have moved forward in the meantime. Keep your local master branch in sync with these commands:
25+
The scikit-hep main may have moved forward in the meantime. Keep your local main branch in sync with these commands:
2626
```
27-
git checkout master
28-
git pull upstream master
27+
git checkout main
28+
git pull upstream main
2929
git submodule update # update the nested sub-repositories if necessary
3030
```
31-
If you have followed the rule to never commit to the master, then these commands always work. Rebase your feature branch onto the updated master:
31+
If you have followed the rule to never commit to the main, then these commands always work. Rebase your feature branch onto the updated main:
3232
```
3333
git checkout my_cool_feature
34-
git rebase master
34+
git rebase main
3535
```
36-
If conflicts between your changes and those in the master appear, you need to resolve them. Follow the instructions printed by git.
36+
If conflicts between your changes and those in the main appear, you need to resolve them. Follow the instructions printed by git.
3737

3838
## Building
3939

0 commit comments

Comments
 (0)