diff --git a/src/xdocs/contributing.xml b/src/xdocs/contributing.xml index df6862298..95b066067 100644 --- a/src/xdocs/contributing.xml +++ b/src/xdocs/contributing.xml @@ -33,12 +33,12 @@
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 + 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
+ 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.
@@ -67,7 +67,7 @@
Cobertura report, run the Maven command
mvn cobertura:cobertura.
-
+
Check results on report target/site/cobertura/index.html in project home folder.
- The Maven command mvn clean package must pass
+ The Maven command mvn clean verify must pass
without any errors.
- If you add new end user features (Check, Filter, ....), remember to document
+ 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.
+ Please recheck site and all bundles generation by mvn -Pdistro package
@@ -97,7 +98,7 @@
Once you have made sure that your changes pass the Maven command
- mvn clean package, the code coverage is of high
+ mvn clean verify, the code coverage is of high
standard and everything is documented, then you are ready to
submit your work.
Please use Pull Request
feature of Github.
- Please provide wide description of update with detailed explanation of problem
+ Please provide wide description of update with detailed explanation of problem
and how you propose to resolve it.
After you do Pull Request please recheck that our where is no problem from our build system: - Travis and - Coveralls. + Travis and + Coveralls. You will see that your Pull Request on Github is marked by that jobs automatically in few minutes.