Add a PR Checklist for Contributions #7921
Conversation
Signed-off-by: karishma-chawla <74574173+karishma-chawla@users.noreply.github.com>
| Please verify that the PR meets the following requirements, where applicable: | ||
|
|
||
| - [ ] An overview of proposed schema changes is included in a linked GitHub issue. | ||
| - [ ] A design document PR is created in the [design-notes repository](https://github.com/radius-project/design-notes/), if new APIs are being introduced. | ||
| - [ ] A PR for the [samples repository](https://github.com/radius-project/samples) is created, if existing samples are affected by the changes in this PR. | ||
| - [ ] A PR for the [documentation repository](https://github.com/radius-project/docs) is created, if the changes in this PR affect the documentation. |
There was a problem hiding this comment.
This is an initial draft. Please feel free to suggest updates to the list/phrasing etc.
There was a problem hiding this comment.
Should we talk about tests like adding unit and functional tests?
There was a problem hiding this comment.
I like the idea of adding functional tests in the checklist, but hesitant to add it until we build a consensus with the team on it. Mainly because it existed in the old checklist and was removed due to being ignored. @rynowak, do you have strong opinions on this?
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7921 +/- ##
==========================================
- Coverage 60.97% 60.96% -0.01%
==========================================
Files 527 527
Lines 27860 27860
==========================================
- Hits 16988 16986 -2
- Misses 9378 9379 +1
- Partials 1494 1495 +1 ☔ View full report in Codecov by Sentry. |
kachawla
changed the title
kachawla
changed the title
| - [ ] An overview of proposed schema changes is included in a linked GitHub issue. | ||
| - [ ] A design document PR is created in the [design-notes repository](https://github.com/radius-project/design-notes/), if new APIs are being introduced. |
There was a problem hiding this comment.
should we combine these? they either update the GH issue with the details on the schema changes or they do a design doc if it involves new API changes
|
|
||
| - [ ] An overview of proposed schema changes is included in a linked GitHub issue. | ||
| - [ ] A design document PR is created in the [design-notes repository](https://github.com/radius-project/design-notes/), if new APIs are being introduced. | ||
| - [ ] A PR for the [samples repository](https://github.com/radius-project/samples) is created, if existing samples are affected by the changes in this PR. |
There was a problem hiding this comment.
do we want to include more possibilities so we , say, 'add new samples when new features are introduced'.
One suggestion:
..ensure samples repo adequately addresses changes in this PR (which may include addition/update/deletion) of samples
Description
Adding a contribution PR checklist to ensure important areas like, design, samples, and doc updates are covered.
Type of change