Apache Solr open-source search software
document the various code quality tools in our Developer FAQ (#1038)
Eric Pughff7333752e13
diff --git a/dev-docs/FAQ.adoc b/dev-docs/FAQ.adocindex c4f2b002592..15cfbbf9b3f 100644--- a/dev-docs/FAQ.adoc+++ b/dev-docs/FAQ.adoc@@ -51,3 +51,41 @@ Run `gradle dev`, and then `cd ./packaging/build/dev/`. Fire up your clustervia `bin/solr start -e cloud -noprompt` and then as you make changes to assets in `/solr/webapp/web`,run `gradle dev` to redeploy the web assets. Do a hard refresh in your browserto pick up your changes.++=== How do we ensure coding standards and quality?++We use a number of tools for ensuring that Solr's codebase follows our community standards.+The most important tool is the very rich testing infrastructure that Solr enjoys.+We strive for testing of every aspect of Solr.+If you find a bug, write a test demonstrating it, so we can ensure that once the bug is squashed, it stays squashed.++Beyond testing, we also have some tools for ensuring coding standards are followed.+[Spotless](https://github.com/diffplug/spotless) is used to format the Java source code so that everyone uses the same formatting patterns.+Run Spotless via:++`./gradlew tidy`++Learn more via `./gradlew :helpFormatting`.++The Eclipse IDE's linting tool ECJ is applied as part of the `check` task.++[Error Prone](https://errorprone.info/) goes beyond static type checking and recommends fixes for common bug patterns.+Error Prone is run during the CI build on Jenkins, however to run it locally (and skip the tests) do:++`./gradlew check -Pvalidation.errorprone=true -x test`++In the same space as Errorprone is [Sonatype Lift](https://lift.sonatype.com/), an automated code reviewer that is run when you push your PR to Github.+As with human reviewers, it's a good practice to respond to each comment to reflect on the recommendation.+Of course, automated code analysis will turn up false-positives.+Tip: There is no point in responding to Lift with the ignore command because we don't gate PRs on Lift.++There are Java classes and methods that Solr doesn't allow.+This exclusion is enforced by the [Forbidden APIs](https://github.com/policeman-tools/forbidden-apis) tool and is applied as part of the `check` task.+Learn more about using Forbidden APIs via `./gradlew :helpForbiddenApis`.++To run a check for dependencies of Solr that have security vulnerabilities using the [OWASP](https://plugins.gradle.org/plugin/org.owasp.dependencycheck) Gradle plugin.+Run via:++`./gradlew owasp`++There are a number of other tasks that get run to validate the source code, and you can find them in the [./gradle/validation](./gradle/validation) source tree.