StarMirror/qTox
1
0
Fork 0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
Code Issues Projects Releases Wiki Activity

docs(CONTRIBUTING): add more info about shape of PRs

Browse Source 
Text taken from spacemacs @ 3706a42c4346dc555b8e46bea220617ce11a9ddb,
under GPLv3 and adjusted for qTox needs.

3706a42c43/CONTRIBUTING.org
This commit is contained in:
Zetok Zalbavar 2016-10-13 10:52:52 +01:00
parent 2d472004cd
commit cefe17651a
No known key found for this signature in database
GPG Key ID: C953D3880212068A
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.md
View File

@ -53,6 +53,31 @@ simple rules we need to keep qTox a "smooth experience" for everybody involved.
message to the commit `Fixes #4134.`. [Here is an
example](https://github.com/qTox/qTox/commit/87160526d5bafcee7869d6741a06045e13d731d5).
## Pull request
*PR = Pull request*
Ideally for simple PRs (most of them):
* One topic per PR
* One commit per PR
* If you have several commits on different topics, close the PR and create one
PR per topic
* If you still have several commits, squash them into only one commit
* Amend commit after making changes (`git commit --amend path/to/file`)
* Rebase your PR branch on top of upstream `master` before submitting the PR
For complex PRs (big refactoring, etc):
* Squash only the commits with uninteresting changes like typos, docs
improvements, etc… and keep the important and isolated steps in different
commits.
It's important to keep amount of changes in the PR small, since smaller PRs are
easier to review and merging them is quicker. PR diff shouldn't exceed `300`
changed lines, unless it has to.
## How to open a pull request
1. Fork the qTox repository on Github to your existing account.
2. Open a Terminal and do the following steps: