From 75787b5998bfa6ed79ac142f51c9e344e69bf37d Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 15 Dec 2025 01:30:05 +0000 Subject: [PATCH 1/3] Add GitHub Pull Request template Co-authored-by: torosent <17064840+torosent@users.noreply.github.com> --- .github/PULL_REQUEST_TEMPLATE.md | 128 +++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..b9eabfeb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,128 @@ + + +# Summary + +## What changed? + + +## Why is this change needed? + + +## Related issues / work items +- Fixes # +- Related # + +--- + +# Type of change +- [ ] Bug fix +- [ ] New feature +- [ ] Performance improvement +- [ ] Reliability / resiliency improvement +- [ ] Refactor (no behavior change intended) +- [ ] Test-only change +- [ ] Build / CI change +- [ ] Documentation-only change + +--- + +# AI-assisted code disclosure (required) + +## Was an AI tool used? (select one) +- [ ] No, this PR was written without AI assistance +- [ ] Yes, AI helped write parts of this PR (e.g., GitHub Copilot) +- [ ] Yes, an AI agent generated most of this PR + +## If AI was used, complete the following +- Tool(s) used: +- Which files / areas were AI-assisted: +- What you changed after AI generation (review, refactor, bug fixes): + +### AI verification checklist (required if AI was used) +- [ ] I understand the code in this PR and can explain it +- [ ] I verified all referenced APIs/types exist and are correct +- [ ] I reviewed edge cases and failure paths (timeouts, retries, cancellation, exceptions) +- [ ] I reviewed concurrency/async behavior (no deadlocks, no blocking waits, correct cancellation tokens) +- [ ] I checked for unintended breaking changes or behavior changes + +--- + +# Testing + +## Automated tests +### What did you run? + +- Command(s): + +### Results +- [ ] Passed +- [ ] Failed (explain and link logs) + +### Tests added/updated in this PR + +- + +--- + +## Manual validation (required for runtime/behavior changes) +> If this is docs-only or test-only, explain why manual validation is N/A. + +### Environment +- OS: +- .NET SDK/runtime version: +- DurableTask component(s) affected (client/worker/backend/etc.): + +### Scenarios executed (check all that apply) +- [ ] Orchestration start, completion, and replay behavior +- [ ] Activity execution (including retries) +- [ ] Failure handling (exceptions, poison messages, transient failures) +- [ ] Cancellation and termination flows +- [ ] Timers and long-running orchestration behavior +- [ ] Concurrency / scale behavior (multiple instances, parallel activities) +- [ ] Backward compatibility check (old history / upgraded worker) if applicable +- [ ] Other (describe): + +### Steps and observed results (required) + +1. +2. +3. + +Evidence (logs, screenshots, traces, links): +- + +--- + +# Compatibility / Breaking changes + +- [ ] No breaking changes +- [ ] Breaking changes (describe below) + +If breaking: +- Impacted APIs/behavior: +- Migration guidance: +- Versioning considerations: + +--- + +# Review checklist (author) + +- [ ] Code builds locally +- [ ] No unnecessary refactors or unrelated formatting changes +- [ ] Public API changes are justified and documented (XML docs / README / samples as appropriate) +- [ ] Logging is useful and not noisy (no secrets, no PII) +- [ ] Error handling follows existing DurableTask patterns +- [ ] Performance impact considered (hot paths, allocations, I/O) +- [ ] Security considerations reviewed (input validation, secrets, injection, SSRF, etc.) + +--- + +# Notes for reviewers + +- From 8cf986f656de85e7cc1cfe27e027110c701dba09 Mon Sep 17 00:00:00 2001 From: Tomer Rosenthal Date: Mon, 15 Dec 2025 08:25:29 -0800 Subject: [PATCH 2/3] Revise pull request template for better usability Updated the pull request template to streamline sections and improve clarity. --- .github/PULL_REQUEST_TEMPLATE.md | 136 ++++++++----------------------- 1 file changed, 36 insertions(+), 100 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b9eabfeb..3767769d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,128 +1,64 @@ - - # Summary - ## What changed? - +- ## Why is this change needed? - +- -## Related issues / work items -- Fixes # +## Issues / work items +- Resolves # - Related # --- -# Type of change -- [ ] Bug fix -- [ ] New feature -- [ ] Performance improvement -- [ ] Reliability / resiliency improvement -- [ ] Refactor (no behavior change intended) -- [ ] Test-only change -- [ ] Build / CI change -- [ ] Documentation-only change - +# Project checklist +- [ ] Documentation changes are not required + - [ ] Otherwise: Documentation PR is ready to merge and referenced in `pending_docs.md` +- [ ] Release notes are not required for the next release + - [ ] Otherwise: Notes added to `release_notes.md` +- [ ] Backport is not required + - [ ] Otherwise: Backport tracked by issue/PR #issue_or_pr +- [ ] All required tests have been added/updated (unit tests, E2E tests) +- [ ] Breaking change? + - [ ] If yes: + - Impact: + - Migration guidance: --- # AI-assisted code disclosure (required) - ## Was an AI tool used? (select one) -- [ ] No, this PR was written without AI assistance +- [ ] No - [ ] Yes, AI helped write parts of this PR (e.g., GitHub Copilot) - [ ] Yes, an AI agent generated most of this PR -## If AI was used, complete the following -- Tool(s) used: -- Which files / areas were AI-assisted: -- What you changed after AI generation (review, refactor, bug fixes): +If AI was used: +- Tool(s): +- AI-assisted areas/files: +- What you changed after AI output: -### AI verification checklist (required if AI was used) -- [ ] I understand the code in this PR and can explain it -- [ ] I verified all referenced APIs/types exist and are correct -- [ ] I reviewed edge cases and failure paths (timeouts, retries, cancellation, exceptions) -- [ ] I reviewed concurrency/async behavior (no deadlocks, no blocking waits, correct cancellation tokens) -- [ ] I checked for unintended breaking changes or behavior changes +AI verification (required if AI was used): +- [ ] I understand the code and can explain it +- [ ] I verified referenced APIs/types exist and are correct +- [ ] I reviewed edge cases/failure paths (timeouts, retries, cancellation, exceptions) +- [ ] I reviewed concurrency/async behavior +- [ ] I checked for unintended breaking or behavior changes --- # Testing - ## Automated tests -### What did you run? - - Command(s): +- Result: Passed / Failed (link logs if failed) -### Results -- [ ] Passed -- [ ] Failed (explain and link logs) - -### Tests added/updated in this PR - -- - ---- - -## Manual validation (required for runtime/behavior changes) -> If this is docs-only or test-only, explain why manual validation is N/A. - -### Environment -- OS: -- .NET SDK/runtime version: -- DurableTask component(s) affected (client/worker/backend/etc.): - -### Scenarios executed (check all that apply) -- [ ] Orchestration start, completion, and replay behavior -- [ ] Activity execution (including retries) -- [ ] Failure handling (exceptions, poison messages, transient failures) -- [ ] Cancellation and termination flows -- [ ] Timers and long-running orchestration behavior -- [ ] Concurrency / scale behavior (multiple instances, parallel activities) -- [ ] Backward compatibility check (old history / upgraded worker) if applicable -- [ ] Other (describe): - -### Steps and observed results (required) - -1. -2. -3. - -Evidence (logs, screenshots, traces, links): -- - ---- - -# Compatibility / Breaking changes - -- [ ] No breaking changes -- [ ] Breaking changes (describe below) - -If breaking: -- Impacted APIs/behavior: -- Migration guidance: -- Versioning considerations: - ---- - -# Review checklist (author) - -- [ ] Code builds locally -- [ ] No unnecessary refactors or unrelated formatting changes -- [ ] Public API changes are justified and documented (XML docs / README / samples as appropriate) -- [ ] Logging is useful and not noisy (no secrets, no PII) -- [ ] Error handling follows existing DurableTask patterns -- [ ] Performance impact considered (hot paths, allocations, I/O) -- [ ] Security considerations reviewed (input validation, secrets, injection, SSRF, etc.) +## Manual validation (only if runtime/behavior changed) +- Environment (OS, .NET version, components): +- Steps + observed results: + 1. + 2. + 3. +- Evidence (optional): --- # Notes for reviewers - -- +- N/A From 8f3e1da80f62b7ea0af0c17dc5c9af2b7fe52533 Mon Sep 17 00:00:00 2001 From: Tomer Rosenthal Date: Mon, 15 Dec 2025 08:26:33 -0800 Subject: [PATCH 3/3] Simplify PR template checklist Removed unnecessary checklist items from PR template. --- .github/PULL_REQUEST_TEMPLATE.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3767769d..2b1f0e63 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,8 +12,6 @@ --- # Project checklist -- [ ] Documentation changes are not required - - [ ] Otherwise: Documentation PR is ready to merge and referenced in `pending_docs.md` - [ ] Release notes are not required for the next release - [ ] Otherwise: Notes added to `release_notes.md` - [ ] Backport is not required @@ -47,7 +45,6 @@ AI verification (required if AI was used): # Testing ## Automated tests -- Command(s): - Result: Passed / Failed (link logs if failed) ## Manual validation (only if runtime/behavior changed)