Skip to content

Docs update #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs update #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/checkstyle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
16 changes: 13 additions & 3 deletions docs/developer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Checkstyle is configured for this project. See related [documentation](checkstyle.md) for more information and the developer notes.