Skip to content

Commit b02f0a6

Browse files
committed
#37 - More details in the contribution guidelines.
1 parent 0fe7e79 commit b02f0a6

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

CONTRIBUTING.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,19 @@ public void yourTestMethod() { … }
1919
```
2020

2121
- Make sure you added yourself as author in the headers of the classes you touched. Amend the date range in the Apache license header if needed. For new types, add the license header (copy from another file and set the current year only).
22-
- The commit message should follow the following style
22+
- The commit message should follow the following style:
23+
- First line starts with the ticket id.
24+
- Separate ticket id and summary with a dash.
25+
- Finish summary with a dot.
26+
- In the description, don't use single line breaks. No manual wrapping. Separate paragraphs by a blank line.
27+
- Add related references at the very bottom (also see the section on pull requests below).
2328

2429
```
2530
DATA…-??? - Summary of the commit (try to stay under 80 characters).
2631
2732
Additional explanations if necessary.
2833
29-
See also: DATA…-??? (optionally refer to related tickets)
34+
See also: DATA…-???. (optionally refer to related tickets)
3035
```
3136

3237
- Make sure you provide your full name and an email address registered with your GitHub account. If you're a first-time submitter, make sure you have completed the [Contributor's License Agreement form](https://support.springsource.com/spring_committer_signup).
@@ -52,6 +57,7 @@ This section contains some advanced information, mainly targeted at developers o
5257
This section contains some stuff that the IDE formatters do not enforce. Try to keep track of those as well
5358

5459
- Make sure, your IDE uses `.*` imports for all static ones.
60+
- Eclipse users should activate Save Actions to format sources on save, organize imports and also enable the standard set of
5561
- For methods only consisting of a single line, don't use any blank lines around the line of code. For methods consisting of more than one line of code, have a blank line after the method signature.
5662

5763
## Handling pull requests
@@ -73,3 +79,5 @@ curl $PULL_REQUEST_URL.patch | git am --ignore-whitespace
7379
7480
Original pull request: #??.
7581
```
82+
83+
Important pieces here: colon and the sence completed with a dot.

0 commit comments

Comments
 (0)