From 5beb73ab575fbea6303402c4e9bcfdc7043352fe Mon Sep 17 00:00:00 2001 From: ronshapiro Date: Tue, 12 Mar 2019 10:02:53 -0700 Subject: [PATCH] Remove checkstyle references. It's unclear when the last time this was relevant, but we seem to be ignoring it now anyway. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=238038517 --- CONTRIBUTING.md | 14 ++--- checkstyle.xml | 136 ------------------------------------------------ pom.xml | 10 ---- 3 files changed, 4 insertions(+), 156 deletions(-) delete mode 100644 checkstyle.xml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1efdd026d9..b5622f6f7a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,18 +5,18 @@ If you would like to contribute code to Auto you can do so through GitHub by forking the repository and sending a pull request. When submitting code, please make every effort to follow existing conventions -and style in order to keep the code as readable as possible. +and style in order to keep the code as readable as possible. Where appropriate, please provide unit tests or integration tests. Unit tests should be JUnit based tests and can use either standard JUnit assertions or -Truth assertions and be added to `/src/test/java`. Changes to -code generation or other build-time behaviour should go into small maven +Truth assertions and be added to `/src/test/java`. Changes to +code generation or other build-time behaviour should go into small maven projects using the `maven-invoker-plugin`. Examples of this are in `generator/src/it` and can include bean-shell verification scripts and other facilities provided by `maven-invoker-plugin`. Please make sure your code compiles by running `mvn clean verify` which will -execute both unit and integration test phases. Additionally, consider using +execute both unit and integration test phases. Additionally, consider using http://travis-ci.org to validate your branches before you even put them into pull requests. All pull requests will be validated by Travis-ci in any case and must pass before being merged. @@ -27,12 +27,6 @@ note that a Google, Inc. copyright line must appear in every copyright notice. All files are released with the Apache 2.0 license and any new files may only be accepted under the terms of that license. -Checkstyle failures during compilation indicate errors in your style and will -be displayed in the console output of the build (including in Travis-CI output), -or can be viewed in the `checkstyle-result.xml` file. To save yourself some -hassle, consider executing checkstyle first per: 'mvn checkstyle:checkstyle'. -It's fast, and will catch style errors early. - Before your code can be accepted into the project you must sign the [Individual Contributor License Agreement (CLA)][1]. diff --git a/checkstyle.xml b/checkstyle.xml deleted file mode 100644 index 24eeebef9e..0000000000 --- a/checkstyle.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/pom.xml b/pom.xml index b90bf7f7a4..d8df376d6b 100644 --- a/pom.xml +++ b/pom.xml @@ -154,16 +154,6 @@ - - org.apache.maven.plugins - maven-checkstyle-plugin - 2.17 - - true - checkstyle.xml - false - - org.apache.maven.plugins maven-jar-plugin