diff --git a/docs/checkstyle.md b/docs/checkstyle.md index 570da043..5226a365 100644 --- a/docs/checkstyle.md +++ b/docs/checkstyle.md @@ -8,7 +8,7 @@ __Adhering to to these style checks is mandatory.__ In the future the the severity level will be changed to error, and will fail the build. -The `checkstyle.xml` file that defines the checks to be used is under `/eclipse-plugin/eclipse/cc.codechecker.eclipse.parent/` +The `checkstyle.xml` file that defines the checks to be used is under the root of the project. The Maven checkstyle plugin also configured in this folders pom.xml under the build section. diff --git a/docs/developer.md b/docs/developer.md index f9443ec8..d61e3651 100644 --- a/docs/developer.md +++ b/docs/developer.md @@ -7,11 +7,21 @@ ## Development Notes +### General + +* The project resembles to, but not exactly same as this [example project](https://github.com/Vodorok/Eclipse-example-project-for-Tycho), could be a good starting point to understand the layout. * Requires the Tycho Connector, Eclipse will automatically install it for you when you first import the project * Requires Eclipse PDE (Plug-in Development Environment) * WindowMaker plugin is recommended -* Adherence to the [Google Java Style](https://google.github.io/styleguide/javaguide.html) is mandatory - * An IntelliJ Idea autoformatter XML configuration file is included in the repo for convenience +* Coding style: + * Adherence to the [Google Java Style](https://google.github.io/styleguide/javaguide.html) is mandatory + * New code should avoid checkstyle violations. + * Already existing violations should be cleared upon modification. + * Fail on violation is disabled on the unit tests and the plugin itself. Rely on codacy findings on github to discover newly added issues until it's turned on. + +### Tests + +* Please write unit tests for newly added features, as well as integration tests (with SWT bot) if it makes sense. There are a handful of utility methods in the test modules, and there is a shared test project that contains features used by both test. ## Version Update @@ -40,4 +50,4 @@ The loglevel is specified as follows: After modifying the jar file, you will need to restart eclipse for the changes to take effect. ## Checkstyle -Checkstyle is configured for this project. See related [documentation](checkstyle.md) for more information. \ No newline at end of file +Checkstyle is configured for this project. See related [documentation](checkstyle.md) for more information and the developer notes.