Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
Orekit
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Gaëtan Pierre
Orekit
Commits
121104c6
Commit
121104c6
authored
3 years ago
by
Bryan Cazabonne
Browse files
Options
Downloads
Patches
Plain Diff
Added checkstyle verification using Maven in contributing guide.
parent
316b886e
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/site/markdown/contributing.md
+15
-5
15 additions, 5 deletions
src/site/markdown/contributing.md
with
15 additions
and
5 deletions
src/site/markdown/contributing.md
+
15
−
5
View file @
121104c6
...
...
@@ -135,8 +135,8 @@ Here's how to make your first contribution:
represents the issue number.
5.
Be sure to activate checkstyle (use the
**checkstyle.xml**
file at the root
of the project) to help you follow the coding rules of Orekit (see
Eclipse
example below).
of the project) to help you follow the coding rules of Orekit (see
example
s
below).
6.
Perform your development and validation.
...
...
@@ -177,12 +177,22 @@ compliant with a coding standard. It automates the process of checking Java
code to spare humans of this boring (but important) task. This makes it ideal
for projects that want to enforce a coding standard.
Configuring checkstyle can be a difficult task when installing Orekit in an
Integrated Development Environment (IDE). However, it is an important step for
contributing to the library.
### Verify checkstyle using Maven
Checkstyle violations can be quickly verified in a Linux terminal by using
Maven commands. Contributors can execute the following command in the same
folder as the
`pom.xml`
file:
mvn checkstyle:check findbugs:check test
Note that this command is also used to check that no Spotbugs warning were
created (
`findbugs:check`
) and that the tests are running correctly (
`test`
).
### Configure checkstyle in Eclipse
Configuring checkstyle can be a difficult task when installing Orekit in an
Integrated Development Environment (IDE). However, it is an important step for
contributing to the library.
Here are the steps you will need to follow to configure checkstyle in Eclipse.
#### Installing Eclipse Checkstyle plugin.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment