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
ada7f74f
Commit
ada7f74f
authored
3 years ago
by
Sébastien Dinot
Browse files
Options
Downloads
Patches
Plain Diff
Take into account Luc remarks
parent
03703e9f
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
+14
-14
14 additions, 14 deletions
src/site/markdown/contributing.md
with
14 additions
and
14 deletions
src/site/markdown/contributing.md
+
14
−
14
View file @
ada7f74f
...
...
@@ -24,12 +24,12 @@ This document is intended to help you take your first steps in the project.
You can contribute in many ways:
*
[
Participate in the
exchange
s on the forum
](
#participate
)
*
[
Participate in the
discussion
s on the forum
](
#participate
)
*
[
Report bugs or feature requests
](
#report-bugs
)
*
[
Improve the documentation
](
#improve-documentation
)
*
[
Improve or extend the source code
](
#improve-source-code
)
<span
id=
"participate"
>
**Participate in the
exchange
s on the forum**
</span>
<span
id=
"participate"
>
**Participate in the
discussion
s on the forum**
</span>
You can participate in discussions on the
[
forum
](
https://forum.orekit.org/
)
,
share your experience with Orekit or in space flight dynamics, provide help to
...
...
@@ -46,14 +46,14 @@ You can report bugs in our
[
bug tracking system
](
https://gitlab.orekit.org/orekit/orekit/-/issues
)
. If
you have trouble qualifying the problem, talk about it on the
[
forum
](
https://forum.orekit.org/
)
first.
**
And remember: the more information
we get, the easier
we
can reproduce and fix it.
**
we get, the easier
the community
can reproduce and fix it.
**
The bug tracking system is also the right place to report your feature
requests. We do not promise you to take them into account, and even less to do
it quickly, because we have limited human resources and our own priorities.
But by expressing your needs in the tracking system, you leave a record of
them and a contributor will be able to implement the feature when he
will b
e
available.
them and a contributor will be able to implement the feature when he
or sh
e
will be
available.
<span
id=
"improve-documentation"
>
**Improve the documentation**
</span>
...
...
@@ -166,10 +166,10 @@ distributed under the Apache License Version 2.0.
## Configure Orekit checkstyle
Checkstyle is a development tool to help programmers write Java code that
adheres to
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.
Checkstyle is a development tool to help programmers write Java code that
is
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
...
...
@@ -202,9 +202,9 @@ the context menu of the project explorer panel.
In the
*Properties*
popup, select
*Checkstyle*
entry.
In this second popup (i.e.
*Local Check Configurations*
) define a project
relative configuration as presented in the figure below.
We b
rowse the
workspace
to select our checkstyle.xml file, and
we
tick the
*
Protect
Checkstyle
configuration file
*
check box to prevent the plugin to alter the
relative configuration as presented in the figure below.
B
rowse the
workspace
to select
y
our checkstyle.xml file, and tick the
*
Protect
Checkstyle
configuration file
*
check box to prevent the plugin to alter the
configuration.

.
...
...
@@ -268,8 +268,8 @@ initialize the project in SonarQube. Here is how to do it.
6.
After that, you can run again the pipeline on your working branch.
If your working branch is from an older version of Orekit, step 5 described
above will not work because of the
previous state of the continuous
integration script
. In this case, you will need to initiate the project in
above will not work because of the
continuous integration scripts did not
manage forks properly
. In this case, you will need to initiate the project in
SonarQube from your workstation, by executing the following commands:
```
bash
...
...
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