diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 511a9f5697..46330a6d14 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,6 +57,14 @@ All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help] for more information on using pull requests. +Process for code reviews. Before requesting human review, a PR must: + +* Must have all tests passing +* Must have all linting passing +* Must meet project code quality requirements, including passing all configured static analysis / SonarCloud quality gates and not reducing automated test coverage for the affected components +* Must have all automatically generated comments addressed (AI generated comments, SonarCloud comments, bot generated comments etc) +* If it is not possible to resolve an automatic comment, please add a sub-comment indicating why the automated comment cannot be resolved or ask for help in resolving the comment + ## Community Guidelines This project follows a [Code of Conduct]. @@ -126,7 +134,7 @@ It's usually a good idea to test locally for the following: #### Update docs -Docs are under [documentation/]. Refer to (the README,md)[documentation/README.md] in the folder to details about +Docs are under [documentation/](documentation/). Refer to the [README.md](documentation/README.md) in the folder for details about documentation contributions.