|
| 1 | +<!-- |
| 2 | +(c) Copyright IBM Corp. 2017, 2017 All Rights Reserved |
| 3 | +
|
| 4 | +This code is free software; you can redistribute it and/or modify it |
| 5 | +under the terms of the GNU General Public License version 2 only, as |
| 6 | +published by the Free Software Foundation. |
| 7 | +
|
| 8 | +This code is distributed in the hope that it will be useful, but WITHOUT |
| 9 | +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 10 | +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 11 | +version 2 for more details (a copy is included in the LICENSE file that |
| 12 | +accompanied this code). |
| 13 | +
|
| 14 | +You should have received a copy of the GNU General Public License version |
| 15 | +2 along with this work; if not, see <http://www.gnu.org/licenses/>. |
| 16 | +--> |
| 17 | + |
| 18 | +## Submitting a contribution to OpenJ9 OpenJDK JDK9 extensions |
| 19 | + |
| 20 | +You can propose contributions by sending pull requests (PRs) through GitHub. |
| 21 | +Following these guidelines will help us merge your pull requests smoothly: |
| 22 | + |
| 23 | +1. Your pull request is an opportunity to explain both what changes you'd like |
| 24 | + pulled in, but also _why_ you'd like them added. Providing clarity on why |
| 25 | + you want changes makes it easier to accept, and provides valuable context to |
| 26 | + review. |
| 27 | + |
| 28 | +2. Follow the commit guidelines found below. |
| 29 | + |
| 30 | +3. We encourage you to open a pull request early, and mark it as "Work In |
| 31 | + Progress", by prefixing the PR title with "WIP". This allows feedback to |
| 32 | + start early, and helps create a better end product. Committers will wait |
| 33 | + until after you've removed the WIP prefix to merge your changes. |
| 34 | + |
| 35 | +## Commit Guidelines |
| 36 | + |
| 37 | +The first line describes the change made. It is written in the imperative mood, |
| 38 | +and should say what happens when the patch is applied. Keep it short and |
| 39 | +simple. The first line should be less than 70 characters, where reasonable, |
| 40 | +and should be written in sentence case preferably not ending in a period. |
| 41 | +Leave a blank line between the first line and the message body. |
| 42 | + |
| 43 | +The body should be wrapped at 72 characters, where reasonable. |
| 44 | + |
| 45 | +Include as much information in your commit as possible. You may want to include |
| 46 | +designs and rationale, examples and code, or issues and next steps. Prefer |
| 47 | +copying resources into the body of the commit over providing external links. |
| 48 | +Structure large commit messages with headers, references etc. Remember, however, |
| 49 | +that the commit message is always going to be rendered in plain text. |
| 50 | + |
| 51 | +Use the commit footer to place commit metadata. The footer is the last block of |
| 52 | +contiguous text in the message. It is separated from the body by one or more |
| 53 | +blank lines, and as such cannot contain any blank lines. Lines in the footer are |
| 54 | +of the form: |
| 55 | + |
| 56 | +``` |
| 57 | +Key: Value |
| 58 | +``` |
| 59 | + |
| 60 | +When a commit has related issues or commits, explain the relation in the message |
| 61 | +body. You should also leave an `Issue` tag in the footer. For example: |
| 62 | + |
| 63 | +``` |
| 64 | +Correct race in frobnicator |
| 65 | +
|
| 66 | +This patch eliminates the race condition in issue #1234. |
| 67 | +
|
| 68 | +Fixes: #1234 |
| 69 | +``` |
| 70 | + |
| 71 | +Sign off on your commit in the footer. By doing this, you assert original |
| 72 | +authorship of the commit and that you are permitted to contribute it. This can |
| 73 | +be automatically added to your commit by passing `-s` to `git commit`, or by |
| 74 | +manually adding the following line to the footer of the commit. |
| 75 | + |
| 76 | +``` |
| 77 | +Signed-off-by: Full Name <email> |
| 78 | +``` |
| 79 | + |
| 80 | +Remember, if a blank line is found anywhere after the `Signed-off-by` line, the |
| 81 | +`Signed-off-by:` will be considered outside of the footer, and will fail the |
| 82 | +automated Signed-off-by validation. |
| 83 | + |
| 84 | +When appropriate, use the keywords described in the following help article to |
| 85 | +automatically close issues. |
| 86 | +https://help.github.com/articles/closing-issues-using-keywords/ |
| 87 | + |
| 88 | +### Example commits |
| 89 | + |
| 90 | +Here is an example of a *good* commit: |
| 91 | + |
| 92 | +``` |
| 93 | +Update and expand the commit guidelines |
| 94 | +
|
| 95 | +Elaborate on the style guidelines for commit messages. These new |
| 96 | +style guidelines reflect the conversation found in #124. |
| 97 | +
|
| 98 | +The guidelines are changed to: |
| 99 | +- Provide guidance on how to write a good first line. |
| 100 | +- Elaborate on formatting requirements. |
| 101 | +- Relax the advice on using issues for nontrivial commits. |
| 102 | +- Move issue references from the first line to the message footer. |
| 103 | +- Encourage contributors to put more information into the commit |
| 104 | + message. |
| 105 | +
|
| 106 | +Closes: #124 |
| 107 | +Signed-off-by: Robert Young <[email protected]> |
| 108 | +``` |
| 109 | + |
| 110 | +The first line is meaningful and imperative. The body contains enough |
| 111 | +information that the reader understands the why and how of the commit, and its |
| 112 | +relation to any issues. The issue is properly tagged and the commit is signed |
| 113 | +off. |
| 114 | + |
| 115 | +The following is a *bad* commit: |
| 116 | + |
| 117 | +``` |
| 118 | +FIX #124: Changing a couple random things in CONTRIBUTING.md. |
| 119 | +Also, there are some bug fixes in the thread library. |
| 120 | +``` |
| 121 | + |
| 122 | +The commit rolls unrelated changes together in a very bad way. There is not |
| 123 | +enough information for the commit message to be useful. The first line is not |
| 124 | +meaningful or imperative. The message is not formatted correctly, the issue is |
| 125 | +improperly referenced, and the commit is not signed off by the author. |
| 126 | + |
| 127 | +### Other resources for writing good commits |
| 128 | + |
| 129 | +- http://chris.beams.io/posts/git-commit/ |
| 130 | +- https://alistapart.com/article/the-art-of-the-commit |
| 131 | +- https://wiki.openstack.org/wiki/GitCommitMessages |
| 132 | +- http://ablogaboutcode.com/2011/03/23/proper-git-commit-messages-and-an-elegant-git-history |
| 133 | + |
0 commit comments