Add a PR Checklist for Contributions #7921

kachawla · 2024-09-13T00:50:09Z

Description

Adding a contribution PR checklist to ensure important areas like, design, samples, and doc updates are covered.

Type of change

This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).

kachawla · 2024-09-13T00:53:19Z

.github/pull_request_template.md

+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.


This is an initial draft. Please feel free to suggest updates to the list/phrasing etc.

Should we talk about tests like adding unit and functional tests?

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 · 2024-09-13T01:00:00Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.63%. Comparing base (223ec1e) to head (58fd5cf).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7921      +/-   ##
==========================================
- Coverage   60.64%   60.63%   -0.02%     
==========================================
  Files         534      534              
  Lines       28488    28488              
==========================================
- Hits        17277    17273       -4     
- Misses       9698     9700       +2     
- Partials     1513     1515       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Reshrahim · 2024-09-16T17:44:59Z

.github/pull_request_template.md

+- [ ] 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.


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

Could you suggest the user facing phrasing you have on mind for combining these? @Reshrahim

lakshmimsft · 2024-09-16T17:52:25Z

.github/pull_request_template.md

+
+- [ ] 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.


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

If a new sample needs to be added, then that should be covered in the design review discussion (# 2), we can expand that to new API/significant feature to be explicit, if that helps. This list captures what we agreed on in the team meeting.

superbeeny

Should we include design reviews? Is this template just for creating a PR or should it cover the review and approval process as well. It would give contributors a clear idea of the path to accepting the PR.

kachawla · 2024-09-24T18:00:19Z

Should we include design reviews? Is this template just for creating a PR or should it cover the review and approval process as well. It would give contributors a clear idea of the path to accepting the PR.

Thanks for the review, @superbeeny. Do you mean expanding this checklist item to explicitly to call out review + approval of the design doc?

- [ ] A design document PR is created in the [design-notes repository](https://github.com/radius-project/design-notes/), if new APIs are being introduced.

superbeeny · 2024-09-24T18:02:53Z

Should we include design reviews? Is this template just for creating a PR or should it cover the review and approval process as well. It would give contributors a clear idea of the path to accepting the PR.

Thanks for the review, @superbeeny. Do you mean expanding this checklist item to explicitly to call out review + approval of the design doc?

- [ ] A design document PR is created in the [design-notes repository](https://github.com/radius-project/design-notes/), if new APIs are being introduced.

Yes, it gives contributors immediate visibility into the status of the PR

kachawla · 2024-09-24T18:03:56Z

Should we include design reviews? Is this template just for creating a PR or should it cover the review and approval process as well. It would give contributors a clear idea of the path to accepting the PR.

Thanks for the review, @superbeeny. Do you mean expanding this checklist item to explicitly to call out review + approval of the design doc?
- [ ] A design document PR is created in the [design-notes repository](https://github.com/radius-project/design-notes/), if new APIs are being introduced.

Yes, it gives contributors immediate visibility into the status of the PR

That makes sense, I'll update it.

radius-functional-tests · 2024-09-27T01:22:57Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	kachawla/radius
Commit ref	`771ac88`
Unique ID	func6c9ad5ee65
Image tag	pr-func6c9ad5ee65

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr: 1.12.0
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func6c9ad5ee65
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func6c9ad5ee65
controller test image location: ghcr.io/radius-project/dev/controller:pr-func6c9ad5ee65
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func6c9ad5ee65
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting ucp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
⌛ Starting datastoresrp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded
✅ datastoresrp-cloud functional tests succeeded

radius-functional-tests · 2024-09-27T01:31:56Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	kachawla/radius
Commit ref	`c06a86b`
Unique ID	func24847914c8
Image tag	pr-func24847914c8

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr: 1.12.0
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func24847914c8
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func24847914c8
controller test image location: ghcr.io/radius-project/dev/controller:pr-func24847914c8
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func24847914c8
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting ucp-cloud functional tests...
⌛ Starting datastoresrp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ datastoresrp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

radius-functional-tests · 2024-10-01T20:20:44Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	kachawla/radius
Commit ref	`31bf25d`
Unique ID	func52ad013c92
Image tag	pr-func52ad013c92

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr: 1.12.0
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func52ad013c92
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func52ad013c92
controller test image location: ghcr.io/radius-project/dev/controller:pr-func52ad013c92
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func52ad013c92
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting corerp-cloud functional tests...
⌛ Starting datastoresrp-cloud functional tests...
⌛ Starting ucp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ datastoresrp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

.github/pull_request_template.md

Signed-off-by: karishma-chawla <[email protected]>

radius-functional-tests · 2024-10-01T23:15:31Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	kachawla/radius
Commit ref	`58fd5cf`
Unique ID	func5a5109aeab
Image tag	pr-func5a5109aeab

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr: 1.12.0
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func5a5109aeab
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func5a5109aeab
controller test image location: ghcr.io/radius-project/dev/controller:pr-func5a5109aeab
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func5a5109aeab
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting ucp-cloud functional tests...
⌛ Starting datastoresrp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ datastoresrp-cloud functional tests succeeded
⌛ Starting corerp-cloud functional tests...
✅ corerp-cloud functional tests succeeded

kachawla requested review from rynowak and willtsai September 13, 2024 00:50

kachawla requested review from a team as code owners September 13, 2024 00:50

kachawla commented Sep 13, 2024

View reviewed changes

kachawla changed the title ~~Add a PR checklist for pre and post implementation requirements.~~ Add a PR checklist for. Sep 16, 2024

kachawla changed the title ~~Add a PR checklist for.~~ Add a PR Checklist for Contributions Sep 16, 2024

Reshrahim reviewed Sep 16, 2024

View reviewed changes

lakshmimsft reviewed Sep 16, 2024

View reviewed changes

superbeeny reviewed Sep 24, 2024

View reviewed changes

kachawla force-pushed the pr-checklist branch from 31f41c7 to 771ac88 Compare September 27, 2024 01:21

kachawla temporarily deployed to functional-tests September 27, 2024 01:22 — with GitHub Actions Inactive

kachawla temporarily deployed to functional-tests September 27, 2024 01:31 — with GitHub Actions Inactive

ytimocin force-pushed the pr-checklist branch from c06a86b to 250aae7 Compare September 27, 2024 06:55

ytimocin previously approved these changes Sep 27, 2024

View reviewed changes

kachawla temporarily deployed to functional-tests October 1, 2024 20:19 — with GitHub Actions Inactive

lakshmimsft previously approved these changes Oct 1, 2024

View reviewed changes

lakshmimsft reviewed Oct 1, 2024

View reviewed changes

.github/pull_request_template.md Outdated Show resolved Hide resolved

kachawla added 4 commits October 1, 2024 16:12

Add a PR checklist for pre and post implementation requirements.

39eff2c

Signed-off-by: karishma-chawla <[email protected]>

Include design review and add clarity on doc updates

9846c9c

Signed-off-by: karishma-chawla <[email protected]>

Update contribution doc

4bd030e

Signed-off-by: karishma-chawla <[email protected]>

Include recipes repo

58fd5cf

Signed-off-by: karishma-chawla <[email protected]>

kachawla dismissed lakshmimsft’s stale review via 58fd5cf October 1, 2024 23:13

kachawla dismissed ytimocin’s stale review via 58fd5cf October 1, 2024 23:13

kachawla force-pushed the pr-checklist branch from 31bf25d to 58fd5cf Compare October 1, 2024 23:13

kachawla temporarily deployed to functional-tests October 1, 2024 23:14 — with GitHub Actions Inactive

lakshmimsft approved these changes Oct 3, 2024

View reviewed changes

kachawla merged commit ecd79d1 into radius-project:main Oct 3, 2024
28 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a PR Checklist for Contributions #7921

Add a PR Checklist for Contributions #7921

kachawla commented Sep 13, 2024 •

edited

Loading

kachawla Sep 13, 2024

ytimocin Sep 13, 2024

kachawla Sep 13, 2024

codecov bot commented Sep 13, 2024 •

edited

Loading

Reshrahim Sep 16, 2024

kachawla Sep 23, 2024 •

edited

Loading

lakshmimsft Sep 16, 2024

kachawla Sep 23, 2024 •

edited

Loading

superbeeny left a comment

kachawla commented Sep 24, 2024

superbeeny commented Sep 24, 2024

kachawla commented Sep 24, 2024

radius-functional-tests bot commented Sep 27, 2024 •

edited

Loading

radius-functional-tests bot commented Sep 27, 2024 •

edited

Loading

radius-functional-tests bot commented Oct 1, 2024 •

edited

Loading

radius-functional-tests bot commented Oct 1, 2024 •

edited

Loading

		- [ ] 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.

Add a PR Checklist for Contributions #7921

Add a PR Checklist for Contributions #7921

Conversation

kachawla commented Sep 13, 2024 • edited Loading

Description

Type of change

kachawla Sep 13, 2024

Choose a reason for hiding this comment

ytimocin Sep 13, 2024

Choose a reason for hiding this comment

kachawla Sep 13, 2024

Choose a reason for hiding this comment

codecov bot commented Sep 13, 2024 • edited Loading

Codecov Report

Reshrahim Sep 16, 2024

Choose a reason for hiding this comment

kachawla Sep 23, 2024 • edited Loading

Choose a reason for hiding this comment

lakshmimsft Sep 16, 2024

Choose a reason for hiding this comment

kachawla Sep 23, 2024 • edited Loading

Choose a reason for hiding this comment

superbeeny left a comment

Choose a reason for hiding this comment

kachawla commented Sep 24, 2024

superbeeny commented Sep 24, 2024

kachawla commented Sep 24, 2024

radius-functional-tests bot commented Sep 27, 2024 • edited Loading

Radius functional test overview

Test Status

radius-functional-tests bot commented Sep 27, 2024 • edited Loading

Radius functional test overview

Test Status

radius-functional-tests bot commented Oct 1, 2024 • edited Loading

Radius functional test overview

Test Status

radius-functional-tests bot commented Oct 1, 2024 • edited Loading

Radius functional test overview

Test Status

kachawla commented Sep 13, 2024 •

edited

Loading

codecov bot commented Sep 13, 2024 •

edited

Loading

kachawla Sep 23, 2024 •

edited

Loading

kachawla Sep 23, 2024 •

edited

Loading

radius-functional-tests bot commented Sep 27, 2024 •

edited

Loading

radius-functional-tests bot commented Sep 27, 2024 •

edited

Loading

radius-functional-tests bot commented Oct 1, 2024 •

edited

Loading

radius-functional-tests bot commented Oct 1, 2024 •

edited

Loading