diff options
author | Drew DeVault <sir@cmpwn.com> | 2016-07-28 07:47:44 -0400 |
---|---|---|
committer | Drew DeVault <sir@cmpwn.com> | 2016-07-28 07:47:44 -0400 |
commit | 178063319cc5380f0f82a1bd384bc4f6420e043c (patch) | |
tree | 25e2fc45549587146fb114ce0b3c039cdafb5841 | |
parent | Merge pull request #793 from thejan2009/workspace_layout_first_window_fix (diff) | |
download | sway-178063319cc5380f0f82a1bd384bc4f6420e043c.tar.gz sway-178063319cc5380f0f82a1bd384bc4f6420e043c.tar.zst sway-178063319cc5380f0f82a1bd384bc4f6420e043c.zip |
Add commit message guidelines to CONTRIBUTING.md
-rw-r--r-- | CONTRIBUTING.md | 23 |
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: | |||
24 | 4. git push -u origin add-so-and-so-feature | 24 | 4. git push -u origin add-so-and-so-feature |
25 | 5. Make pull request from your feature branch | 25 | 5. Make pull request from your feature branch |
26 | 26 | ||
27 | ## Commit Messages | ||
28 | |||
29 | Please strive to write good commit messages. Here's some guidelines to follow: | ||
30 | |||
31 | The first line should be limited to 50 characters and should be a sentence that | ||
32 | completes the thought [When applied, this commit will...] "Implement cmd_move" | ||
33 | or "Fix #742" or "Improve performance of arrange_windows on ARM" or similar. | ||
34 | |||
35 | The subsequent lines should be seperated from the subject line by a single | ||
36 | blank line, and include optional details. In this you can give justification | ||
37 | for the change, [reference Github | ||
38 | issues](https://help.github.com/articles/closing-issues-via-commit-messages/), | ||
39 | or explain some of the subtler details of your patch. This is important because | ||
40 | when 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 | ||
42 | it. It's also easier to review your pull requests if they're seperated into | ||
43 | logical commits that have good commit messages and justify themselves in the | ||
44 | extended commit description. | ||
45 | |||
46 | As a good rule of thumb, anything you might put into the pull request | ||
47 | description on Github is probably fair game for going into the extended commit | ||
48 | message as well. | ||
49 | |||
27 | ## Coding Style | 50 | ## Coding Style |
28 | 51 | ||
29 | Sway is written in C. The style guidelines is [kernel | 52 | Sway is written in C. The style guidelines is [kernel |