From c514b6c5d8945d2b94b3d251aea62a768544e60b Mon Sep 17 00:00:00 2001 From: Roman Ivanov Date: Tue, 5 Aug 2014 13:58:28 -0700 Subject: [PATCH] converting contributing.xml to new GIT workflow --- src/xdocs/contributing.xml | 51 ++++++++++++++++++++++++-------------- 1 file changed, 33 insertions(+), 18 deletions(-) diff --git a/src/xdocs/contributing.xml b/src/xdocs/contributing.xml index 6607b2a01..df6862298 100644 --- a/src/xdocs/contributing.xml +++ b/src/xdocs/contributing.xml @@ -22,14 +22,27 @@

- This document assumes you are working with the SVN version of + This document assumes you are working with the GIT version of checkstyle and that you are familiar with some standard development tools ( - SVN, + GIT, Maven, JUnit).

+

+ ATTENTION: if you have idea how to improve Checkstyle please create issue on + on our tracking system. + As soon as one of admins of our project approved your idea you are good to start + implementation and you will be welcome with final code contribution. + Please do not expect that we will accept any code that you send to us. +

+

+ ATTENTION: any new Check that you are going to introduce you need to contribute to our + sanbox project sevntu.checkstyle. + We are receiving only bug fixes for now to our main project, here is a + reason. +

@@ -54,6 +67,8 @@ Cobertura report, run the Maven command mvn cobertura:cobertura. + + Check results on report target/site/cobertura/index.html in project home folder.

@@ -67,7 +82,14 @@

- If you add new end user features, remember to document them. + If you add new end user features (Check, Filter, ....), remember to document + them in JavaDoc of java classes and xdoc files that used to generate that site. +

+ +

+ The last step of verification that all works fine please do testing of your + functionality on any open-source project (Spring, Hibernate, ....). + Here is how to do it from command line

@@ -81,24 +103,17 @@

- If you have created new files, put them in a tgz file (or zip if - you are on Windows). If you have changed existing files, create - a unified diff using SVN. To do that, open a command line, cd to - the home directory of checkstyle (where build.xml is located) - and execute svn diff > mychanges.patch. + Please use Pull Request + feature of Github.
+ Please provide wide description of update with detailed explanation of problem + and how you propose to resolve it.

- Create a new item in our - - patch tracker - - and add the tgz/zip/patch files you created. Make sure the text - in the tracker explains the purpose of your contribution. When - you create a tracker entry, a notification email about your - contribution will automatically be sent to the developer mailing - list. Be prepared to answer questions and do some polishing - work. + After you do Pull Request please recheck that our where is no problem from our build system: + Travis and + Coveralls. + You will see that your Pull Request on Github is marked by that jobs automatically in few minutes.