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

#308 - Update contribution guide with new ticket reference style.

Browse Source 
Change ticket reference style from Javadoc @see DATA…-??? to @Test // DATA…-???. Using @see requires either a Java symbol or a valid HTML link <a href=…>…</a>. To not include links to resources that might change, we  decided to put the ticket reference directly after the test annotation.
This commit is contained in:
Mark Paluch
2017-01-13 10:32:09 +01:00
parent 0e69e0e3de
commit 24db8b32c7
1 changed files with 2 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.adoc
View File

@@ -20,10 +20,7 @@ For the impatient, if you want to submit a quick pull request:
[source, java]
----
/**
* @see DATA…-???
*/
@Test
@Test // DATA…-???
public void yourTestMethod() { … }
----
@@ -100,4 +97,4 @@ curl $PULL_REQUEST_URL.patch | git am --ignore-whitespace
Original pull request: #??.
----
Important pieces here: colon and the sence completed with a dot.
Important pieces here: colon and the sentence completed with a dot.