Update CONTRIBUTING file with PR review rules#4452
Open
CsatariGergely wants to merge 2 commits intokptdev:mainfrom
Open
Update CONTRIBUTING file with PR review rules#4452CsatariGergely wants to merge 2 commits intokptdev:mainfrom
CsatariGergely wants to merge 2 commits intokptdev:mainfrom
Conversation
Plus fixing some broken links. Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
CsatariGergely
requested review from
efiacor,
kispaljr,
liamfallon and
mozesl-nokia
as code owners
dosubot
bot
added
the
size:S
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates contributor guidance to clarify prerequisites before requesting human PR review, and fixes documentation link formatting in the docs section.
Changes:
- Adds a checklist for required CI/quality gates before requesting human code review.
- Fixes broken Markdown links to the
documentation/folder and itsREADME.md.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+62
to
+65
| * 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) |
There was a problem hiding this comment.
The list mixes an introductory sentence that already says “must” with bullets that also start with “Must…”. For clarity/consistency in CONTRIBUTING, consider either changing the bullets to short phrases (e.g., “All tests passing”) or converting the intro line to a heading and keeping “Must …” in bullets—avoid duplicating the modal.
Suggested change
| * 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) | |
| * All tests passing | |
| * All linting passing | |
| * Meeting project code quality requirements, including passing all configured static analysis / SonarCloud quality gates and not reducing automated test coverage for the affected components | |
| * All automatically generated comments addressed (AI generated comments, SonarCloud comments, bot generated comments etc) |
| * 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) |
There was a problem hiding this comment.
In parenthetical lists, add a comma before “etc.” for correct punctuation.
Suggested change
| * Must have all automatically generated comments addressed (AI generated comments, SonarCloud comments, bot generated comments etc) | |
| * Must have all automatically generated comments addressed (AI generated comments, SonarCloud comments, bot generated comments, etc.) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.