Spring/spring-data-build
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#584 - Improved contribution guidelines on commit messages.

Browse Source 
Extracted commit messages guidelines into separate linkable section. Require capital letter in the summary. Added guidelines on linke the original pull request.
This commit is contained in:
Oliver Gierke
2018-06-18 11:11:25 +02:00
parent b86c0c0d11
commit 7c780ddaf7
1 changed files with 17 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
CONTRIBUTING.adoc
View File

@@ -25,12 +25,21 @@ public void yourTestMethod() { … }
----
* 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).
* The commit message should follow the following style:
** First line starts with the ticket id.
** Separate ticket id and summary with a dash.
** Finish summary with a dot.
** In the description, don't use single line breaks. No manual wrapping. Separate paragraphs by a blank line.
** Add related references at the very bottom (also see the section on pull requests below).
* Make sure you follow the <<commit-messages>> guidelines.
* 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 signed the https://cla.pivotal.io/sign/spring[Contributor License Agreement].
[[commit-messages]]
== Commit messages
The commit message should follow the following style:
* First line starts with the ticket id.
* Separate ticket id and summary with a dash.
* Start summary with a capital letter.
* Finish summary with a dot.
* In the description, don't use single line breaks. No manual wrapping. Separate paragraphs by a blank line.
* During merges, add a reference to the original pull request.
* Add related references at the very bottom (also see the section on pull requests below).
[source]
----
@@ -38,12 +47,10 @@ DATA…-??? - Summary of the commit (try to stay under 80 characters).
Additional explanations if necessary.
See also: DATA…-???. (optionally refer to related tickets)
Original pull reuqest: #??.
Related tickets: DATA…-???. (optionally refer to related tickets)
----
* 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 signed the https://cla.pivotal.io/sign/spring[Contributor License Agreement].
[[advanced]]
== Advanced