From 24db8b32c74fda2c7b05b7db468c051ef0fe295b Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Fri, 13 Jan 2017 10:32:09 +0100 Subject: [PATCH] #308 - Update contribution guide with new ticket reference style. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change ticket reference style from Javadoc @see DATA…-??? to @Test // DATA…-???. Using @see requires either a Java symbol or a valid HTML link …. To not include links to resources that might change, we decided to put the ticket reference directly after the test annotation. --- CONTRIBUTING.adoc | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 79a31a38..bba08e5c 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -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.