search

green-code-initiative / ecoCode

Reduce the environmental footprint of your software programs with SonarQube
https://ecocode.io
GNU General Public License v3.0
165 stars 78 forks source link

Rule specifications normalization #349

Open pbaumard opened 3 months ago

pbaumard commented 3 months ago
  1. Mainly ensures the Sonar guidelines for rule specifications are followed with tests. This should avoid most of the comments made by Sonar reviewers, e.g. in ecocode plugin request or ecocode js plugin request.
  2. Use standard sustainability tag instead of eco-design since SonarSource is considering adding Sustainability as a standard software quality
  3. Add Clean code attributes for all rules.
  4. Improved description wording with shorter sentences.
  5. Avoid mardown in asciidoc files to ease the use of asciidoc editors
dedece35 commented 3 months ago

pbaumard

Hi @pbaumard ,

thank you for this PR ... very interesting but a lot of modifications. Can you give us your reference documentation to prove or support your proposition ?

Furthermore, your build is not ok on github action ... please make a correction for it. In my local machine (Mac OS), when I launch your unit test, I have a different error : 

[INFO] Running fr.greencodeinitiative.RulesTest
[ERROR] Tests run: 1, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 0.506 s <<< FAILURE! -- in fr.greencodeinitiative.RulesTest
[ERROR] fr.greencodeinitiative.RulesTest.testRules -- Time elapsed: 0.018 s <<< FAILURE!
org.opentest4j.AssertionFailedError: array contents differ at index [0], expected: <csharp> but was: <python>

please check it in your local machine.

Last question : why is your PR in Draft mode ? Do you still want to work on it ?

pbaumard commented 2 months ago

This PR is now ready for review.

pbaumard commented 2 months ago

@dedece35 Any chance to get this PR reviewed?

It would then be necessary to update all plugins. Android plugin would neeed to migrate to ecoCode rule specifications: https://github.com/green-code-initiative/ecoCode-android/issues/79

dedece35 commented 2 months ago

@dedece35 Any chance to get this PR reviewed?

It would then be necessary to update all plugins. Android plugin would neeed to migrate to ecoCode rule specifications: green-code-initiative/ecoCode-android#79

hello ... thank you for the work ... review in progress !

dedece35 commented 2 months ago

HI @zippy1978 and @olegoaer, could you please make a review on all modifications done for EC5XX et and EC6XX, please ?

pbaumard commented 1 month ago

review in progress !

@dedece35 Any progress on the review?

I don't see any point waiting for me. Please remove the label "waiting commiter" to clarify this PR status.