Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (32 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

50 lines (32 loc) · 1.99 KB

Contributing to the Node and Label Parameter plugin

Plugin source code is hosted on GitHub. New feature proposals and bug fix proposals should be submitted as GitHub pull requests. Your pull request will be evaluated by the Jenkins job.

Before submitting your change, please assure that you've added tests that verify the change.

Code formatting

Source code and pom file formatting is maintained by the spotless maven plugin. Before submitting a pull request, confirm the formatting is correct with:

  • mvn spotless:apply

Spotbugs checks

Please don't introduce new spotbugs output.

  • mvn spotbugs:check analyzes the project using Spotbugs
  • mvn spotbugs:gui displays the spotbugs report using GUI

Code coverage

Code coverage reporting is available as a maven target. Please try to improve code coverage with tests when you submit pull requests.

  • mvn -P enable-jacoco clean install jacoco:report reports code coverage

Reviewing code coverage

The code coverage report is a set of HTML files that show methods and lines executed. The following commands will open the index.html file in the browser.

  • Windows - start target\site\jacoco\index.html
  • Linux - xdg-open target/site/jacoco/index.html
  • Gitpod - cd target/site/jacoco && python -m http.server 8000

The file will have a list of package names. Click on them to find a list of class names.

The lines of the code will be covered in three different colors, red, green, and orange. Red lines are not covered in the tests. Green lines are covered with tests.

Reporting Issues

Report issues in the Jenkins issue tracker. Please use the "How to Report an Issue" guidelines when reporting issues.