aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2015-11-27 12:23:04 -0500
committerDrew DeVault <sir@cmpwn.com>2015-11-27 12:23:22 -0500
commit89906f4ba1a3621efeefa4969ef549d39451efd4 (patch)
tree8545b50ce8ef926b3e34b696b37281be595ccb20 /CONTRIBUTING.md
parentb7702eb34c9d5485145b0483891e710fae12e967 (diff)
Improve CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8f0ba112..ff2b8b5e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,6 +5,25 @@ successful with your contribution if you visit the [IRC
channel](http://webchat.freenode.net/?channels=sway&uio=d4) upfront and discuss
your plans.
+## Pull Requests
+
+If you already have your own pull request habits, feel free to use them. If you
+don't, however, allow me to make a suggestion: feature branches pulled from
+upstream. Try this:
+
+1. Fork sway
+2. Clone your fork
+3. git remote add upstream git://github.com/SirCmpwn/sway.git
+
+You only need to do this once. You're never going to use your fork's master
+branch. Instead, when you start working on a feature, do this:
+
+1. git fetch upstream
+2. git checkout -b add-so-and-so-feature upstream/master
+3. work
+4. git push -u origin add-so-and-so-feature
+5. Make pull request from your feature branch
+
## Coding Style
Sway is written in C. The style guidelines is [kernel