Skip to content

Commit e77a494

Browse files
committed
Fix community documentation and i-Code version
1 parent 8e47a6d commit e77a494

File tree

9 files changed

+42
-38
lines changed

9 files changed

+42
-38
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,28 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
#### Describe the bug
11+
> _A clear and concise description of what the bug is._
1212
13-
**To reproduce**
14-
Steps to reproduce the behavior:
13+
#### To reproduce
14+
> _Steps to reproduce the behavior._
1515
1. Go to '...'
1616
2. Click on '....'
1717
3. Scroll down to '....'
1818
4. See error
1919

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
20+
#### Expected behavior
21+
> _A clear and concise description of what you expected to happen._
2222
23-
**Screenshots & log**
24-
If applicable, add screenshots to help explain your problem. Then, append SonarQube and i-Code log and **do not forget to obfuscate them**.
23+
#### Screenshots & log
24+
> _If applicable, add screenshots to help explain your problem. Then, append SonarQube and i-Code log and **do not forget to obfuscate them**._
2525
26-
**User environment (please complete the following information):**
26+
#### User environment
27+
> _Please complete the following information._
2728
- OS: [e.g. Windows 10]
2829
- Java version: [e.g. 1.8]
2930
- i-Code version: [e.g. 3.1.0]
3031
- Plugin version: [e.g. 2.0.0]
3132

32-
**Additional context**
33-
Add any other context about the problem here.
33+
#### Additional context
34+
> _Add any other context about the problem here._

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
11-
> A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
#### Is your feature request related to a problem? Please describe.**
11+
> _A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_
1212
13-
**Describe the solution you'd like**
14-
> A clear and concise description of what you want to happen.
13+
#### Describe the solution you'd like
14+
> _A clear and concise description of what you want to happen._
1515
16-
**Describe alternatives you've considered**
17-
> A clear and concise description of any alternative solutions or features you've considered.
16+
#### Describe alternatives you've considered
17+
> _A clear and concise description of any alternative solutions or features you've considered._
1818
19-
**Additional context**
20-
> Add any other context or screenshots about the feature request here.
19+
#### Additional context
20+
> _Add any other context or screenshots about the feature request here._

.github/ISSUE_TEMPLATE/question.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,20 @@ assignees: ''
77

88
---
99

10-
> **Before posting a new question, please read the documentation](https://github.com/lequal/i-CodeCNES/wiki) and check [existing issues](https://github.com/lequal/sonar-icode-cnes-plugin/issues)**
10+
> _Before posting a new question, please read the documentation](https://github.com/lequal/i-CodeCNES/wiki) and check [existing issues](https://github.com/lequal/sonar-icode-cnes-plugin/issues)_
1111
12-
**Describe what you need to know**
13-
> A clear and concise description of what your question is.
12+
#### Describe what you need to know
13+
> _A clear and concise description of what your question is._
1414
15-
**Screenshots & log**
16-
> If applicable, add screenshots to help explain your problem. Then, append i-Code log and **do not forget to obfuscate them**.
15+
#### Screenshots & log
16+
> _If applicable, add screenshots to help explain your problem. Then, append i-Code log and **do not forget to obfuscate them**._
1717
18-
**User environment (please complete the following information):**
18+
#### User environment
19+
> _Please complete the following information._
1920
- OS: [e.g. Windows 10]
2021
- Java version: [e.g. 1.8]
2122
- i-Code version: [e.g. 3.1.0]
2223
- Plugin version: [e.g. 2.0.0]
2324

24-
**Additional context**
25+
#### Additional context
2526
Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Proposed changes
22

3-
> Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
3+
> _Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue._
44
55
## Types of changes
66

.travis.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@ language: java
22
sudo: false
33
install: true
44

5+
os: linux
6+
dist: xenial
7+
58
addons:
69
sonarcloud:
710
organization: "lequal"
811

9-
jdk:
10-
- openjdk8
11-
- openjdk11
12+
jdk: openjdk11
1213

1314
script:
1415
- mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar
@@ -23,13 +24,13 @@ notifications:
2324

2425
deploy:
2526
provider: releases
26-
api_key: "$GITHUB_TOKEN"
27+
token: "$GITHUB_TOKEN"
2728
file_glob: true
2829
file: "target/sonar-icode-cnes-plugin-*.jar"
2930
skip_cleanup: true
30-
name: "Sonar i-Code CNES plugin"
31+
name: "Sonar i-Code CNES plugin version $TRAVIS_TAG"
3132
draft: true
3233
on:
3334
branch: master
3435
tags: true
35-
jdk: 'openjdk11'
36+
jdk: openjdk11

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Here is the compatibility matrix of the plugin:
3030
| < 2.0.0 | none | 6.7.x |
3131
| 2.0.0 | 4.0.0 | 7.9 -> 8.2 |
3232
| 2.0.1 | 4.0.0 | 7.9 -> 8.2 |
33-
| 2.0.2 | 4.0.0 | 7.9 -> 8.2 |
33+
| 2.0.2 | 4.1.0 | 7.9 -> 8.2 |
3434

3535
#### Run i-Code manually
3636
If you need help to run i-Code please refer to the [official user manual](https://github.com/lequal/i-CodeCNES/blob/master/documentation/i-Code%20CNES%20-%20User%20Manual.pdf) or [i-Code issue tracker](https://github.com/lequal/i-CodeCNES/issues).
@@ -78,6 +78,8 @@ If you experienced a problem with the plugin please open an issue. Inside this i
7878

7979
If you want to do a PR, please put inside of it the reason of this pull request. If this pull request fix an issue please insert the number of the issue or explain inside of the PR how to reproduce this issue.
8080

81+
All details are available in [CONTRIBUTING](https://github.com/lequal/sonar-icode-cnes-plugin/CONTRIBUTING.md).
82+
8183
### Feedback and Support
8284
8385

pom.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
</license>
2323
</licenses>
2424

25-
<!-- optional -->
2625
<organization>
2726
<name>CNES</name>
2827
<url>http://cnes.fr</url>
@@ -90,7 +89,7 @@
9089
<dependency>
9190
<groupId>com.github.lequal.i-CodeCNES</groupId>
9291
<artifactId>icode-library</artifactId>
93-
<version>4.1.0-beta</version>
92+
<version>v4.1.0</version>
9493
</dependency>
9594
<dependency>
9695
<groupId>commons-lang</groupId>

src/main/java/fr/cnes/sonar/plugins/icode/check/ICodeSensor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public void describe(final SensorDescriptor sensorDescriptor) {
7474
sensorDescriptor.onlyOnLanguages(ShellLanguage.KEY, Fortran77Language.KEY, Fortran90Language.KEY);
7575

7676
// Defines sensor name
77-
sensorDescriptor.name(getClass().getName());
77+
sensorDescriptor.name("Sonar i-Code");
7878

7979
// Only main files are concerned, not tests.
8080
sensorDescriptor.onlyOnFileType(InputFile.Type.MAIN);

src/test/java/fr/cnes/sonar/plugins/icode/check/ICodeSensorTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ public void test_given_sensorDescriptor_when_describe_then_callSensorDescriptorN
125125
SensorDescriptor sensorDescriptor = Mockito.mock(SensorDescriptor.class);
126126
ICodeSensor icodeMetricsSensor = new ICodeSensor();
127127
icodeMetricsSensor.describe(sensorDescriptor);
128-
verify(sensorDescriptor).name(ICodeSensor.class.getName());
128+
verify(sensorDescriptor).name("Sonar i-Code");
129129
}
130130

131131
@Test

0 commit comments

Comments
 (0)