diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 98650aa99de6..d9c9ea4df089 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,34 +95,51 @@ which will open the workspace in IntelliJ IDEA using JetBrains Gateway. ### Linting -For linting we use a number of tools: +For linting we use a number of tools. + +Backend: - [checkstyle](https://checkstyle.sourceforge.io/) +- [spotbugs](https://github.com/spotbugs/spotbugs) +- [spotless](https://github.com/diffplug/spotless) + +Frontend: + - [eslint](https://eslint.org/) - [prettier](https://prettier.io/) -- [spotless](https://github.com/diffplug/spotless) - [stylelint](https://stylelint.io/) These are all configured to run as part of the Maven build, although they will be skipped if you are building with the `quick-build` profile. To automatically fix backend issues, run: +#### spotless + ```sh mvn spotless:apply ``` + +#### yarn + To view frontend issues, after [optionally adding Node and Yarn to your path](#running-the-yarn-frontend-build), run: ```sh yarn lint ``` -To fix frontend issues, after [optionally adding Node and Yarn to your path](#running-the-yarn-frontend-build), run: +To automatically fix frontend issues, run: ```sh yarn lint:fix ``` +#### prettier + +```sh + prettier --write . +``` + ## Testing changes Jenkins core includes unit and functional tests as a part of the repository.