FlapJackApps/subsurface
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

cleanup: refer to 'main' branch in documentation files

Browse Source 
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This commit is contained in:
Dirk Hohndel 2020-06-16 09:57:58 -07:00
parent 7518029aa2
commit 9c66382201
4 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CODINGSTYLE.md
View File

@ -402,4 +402,4 @@ match ExtraWhitespace /\s\+$\| \+\ze\t/
```
[1]: http://doc.qt.io/qt-5/qstring.html#manipulating-string-data
[2]: https://github.com/Subsurface/subsurface/blob/master/core/membuffer.h
[2]: https://github.com/Subsurface/subsurface/blob/main/core/membuffer.h

6
CONTRIBUTING.md
View File

@ -14,7 +14,7 @@ Here is a very brief introduction on creating commits that you can either send a
Start with getting the latest source.
`cd subsurface`
`git checkout master`
`git checkout main`
`git pull`
ok, now we know you're on the latest version. Create a working branch to keep your development in:
`git checkout -b devel`
@ -22,7 +22,7 @@ Edit the code (or documentation), compile, test… then create a commit:
`git commit -s -a`
Depending on your OS this will open a default editor -- usually you can define which by setting the environment variable `GIT_EDITOR`. Here you enter your commit message. The first line is the title of your commit. Keep it brief and to the point. Then a longer explanation (more on this and the fact that we insist on all contributions containing a Signed-off-by: line below).
If you want to change the commit message, "git commit --amend" is the way to go. Feel free to break your changes into multiple smaller commits. Then, when you are done there are two directions to go, which one you find easier depends a bit on how familiar you are with GitHub. You can either push your branch to GitHub and create a [pull requests on GitHub][6], or you run
`git format-patch master..devel`
`git format-patch main..devel`
Which creates a number of files that have names like 0001-Commit-title.patch, which you can then send to our developer mailing list.
When sending code, please either send signed-off patches or a pull request with signed-off commits. If you don't sign off on them, we will not accept them. This means adding a line that says "Signed-off-by: Name \<Email\>" at the end of each commit, indicating that you wrote the code and have the right to pass it on as an open source patch.
@ -86,4 +86,4 @@ In order to make reviews simpler and have contributions merged faster in the cod
[7]: https://www.kernel.org/pub/software/scm/git/docs/user-manual.html
[8]: https://gerrit-review.googlesource.com/Documentation/user-signedoffby.html
[9]: https://subsurface-divelog.org/wp-content/uploads/2011/10/Screenshot-gitk-subsurface-1.png "Example with gitk"
[10]: https://github.com/Subsurface/subsurface/blob/master/CodingStyle
[10]: https://github.com/Subsurface/subsurface/blob/main/CODINGSTYLE.md

2
INSTALL
View File

@ -21,7 +21,7 @@ repository:
git clone http://github.com/Subsurface/subsurface.git
You keep it updated by doing:
git checkout master
git checkout main
git pull -r

2
README.md
View File

@ -1,4 +1,4 @@
# Subsurface [![Build Status](https://travis-ci.org/Subsurface-divelog/subsurface.svg?branch=master)](https://travis-ci.org/Subsurface-divelog/subsurface)
# Subsurface [![Build Status](https://travis-ci.org/Subsurface-divelog/subsurface.svg?branch=main)](https://travis-ci.org/Subsurface-divelog/subsurface)
This is the README file for Subsurface 4.9.5