aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorLibravatar Drew DeVault <sir@cmpwn.com>2016-07-28 07:47:44 -0400
committerLibravatar Drew DeVault <sir@cmpwn.com>2016-07-28 07:47:44 -0400
commit178063319cc5380f0f82a1bd384bc4f6420e043c (patch)
tree25e2fc45549587146fb114ce0b3c039cdafb5841 /CONTRIBUTING.md
parentMerge pull request #793 from thejan2009/workspace_layout_first_window_fix (diff)
downloadsway-178063319cc5380f0f82a1bd384bc4f6420e043c.tar.gz
sway-178063319cc5380f0f82a1bd384bc4f6420e043c.tar.zst
sway-178063319cc5380f0f82a1bd384bc4f6420e043c.zip
Add commit message guidelines to CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cc29dad0..6d7878ac 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,6 +24,29 @@ branch. Instead, when you start working on a feature, do this:
244. git push -u origin add-so-and-so-feature 244. git push -u origin add-so-and-so-feature
255. Make pull request from your feature branch 255. Make pull request from your feature branch
26 26
27## Commit Messages
28
29Please strive to write good commit messages. Here's some guidelines to follow:
30
31The first line should be limited to 50 characters and should be a sentence that
32completes the thought [When applied, this commit will...] "Implement cmd_move"
33or "Fix #742" or "Improve performance of arrange_windows on ARM" or similar.
34
35The subsequent lines should be seperated from the subject line by a single
36blank line, and include optional details. In this you can give justification
37for the change, [reference Github
38issues](https://help.github.com/articles/closing-issues-via-commit-messages/),
39or explain some of the subtler details of your patch. This is important because
40when someone finds a line of code they don't understand later, they can use the
41`git blame` command to find out what the author was thinking when they wrote
42it. It's also easier to review your pull requests if they're seperated into
43logical commits that have good commit messages and justify themselves in the
44extended commit description.
45
46As a good rule of thumb, anything you might put into the pull request
47description on Github is probably fair game for going into the extended commit
48message as well.
49
27## Coding Style 50## Coding Style
28 51
29Sway is written in C. The style guidelines is [kernel 52Sway is written in C. The style guidelines is [kernel