[roycpro]

https://github.com/ControlSystemStudio/phoebus-codeathon/tree/master/projects#phoebus-dev-003-add-pre-commit-checks-to-pr-template-and-docs

Checklist

• Testing:

  • The feature has automated tests
  • Tests were run
  • If not, explain how you tested your changes

• Documentation:

  • The feature is documented
  • The documentation is up to date
  • Release notes:
    • Added an entry if the change is breaking or significant
    • Added an entry when adding a new feature

[bhargavigit]

I tested it with Cyril Roy and it works as intended.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[jacomago]

I would actually recommend https://prek.j178.dev/ over pre-commit. Its much faster (does checks in parallel) but supports the same pre-commit files.

[jacomago]

Do we really need to have in the PR template that the github actions pass? Shouldn't that just be part of the settings of the project?

[jacomago]

Future problem, but I think moving 'developer'/'contributor' docs out of the README and into a CONTRIBUTING.md and then the README is for 'users'.