|
| 1 | +<!-- |
| 2 | +`durabletask-dotnet` Pull Request Template |
| 3 | +
|
| 4 | +Fill in all sections. If a section does not apply, write "N/A". |
| 5 | +PRs that change runtime behavior must include manual validation steps and results. |
| 6 | +--> |
| 7 | + |
| 8 | +# Summary |
| 9 | + |
| 10 | +## What changed? |
| 11 | +<!-- 1 to 5 sentences. What does this PR do? --> |
| 12 | + |
| 13 | +## Why is this change needed? |
| 14 | +<!-- Link to bug/feature request and describe the problem being solved. --> |
| 15 | + |
| 16 | +## Related issues / work items |
| 17 | +- Fixes # |
| 18 | +- Related # |
| 19 | + |
| 20 | +--- |
| 21 | + |
| 22 | +# Type of change |
| 23 | +- [ ] Bug fix |
| 24 | +- [ ] New feature |
| 25 | +- [ ] Performance improvement |
| 26 | +- [ ] Reliability / resiliency improvement |
| 27 | +- [ ] Refactor (no behavior change intended) |
| 28 | +- [ ] Test-only change |
| 29 | +- [ ] Build / CI change |
| 30 | +- [ ] Documentation-only change |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +# AI-assisted code disclosure (required) |
| 35 | + |
| 36 | +## Was an AI tool used? (select one) |
| 37 | +- [ ] No, this PR was written without AI assistance |
| 38 | +- [ ] Yes, AI helped write parts of this PR (e.g., GitHub Copilot) |
| 39 | +- [ ] Yes, an AI agent generated most of this PR |
| 40 | + |
| 41 | +## If AI was used, complete the following |
| 42 | +- Tool(s) used: |
| 43 | +- Which files / areas were AI-assisted: |
| 44 | +- What you changed after AI generation (review, refactor, bug fixes): |
| 45 | + |
| 46 | +### AI verification checklist (required if AI was used) |
| 47 | +- [ ] I understand the code in this PR and can explain it |
| 48 | +- [ ] I verified all referenced APIs/types exist and are correct |
| 49 | +- [ ] I reviewed edge cases and failure paths (timeouts, retries, cancellation, exceptions) |
| 50 | +- [ ] I reviewed concurrency/async behavior (no deadlocks, no blocking waits, correct cancellation tokens) |
| 51 | +- [ ] I checked for unintended breaking changes or behavior changes |
| 52 | + |
| 53 | +--- |
| 54 | + |
| 55 | +# Testing |
| 56 | + |
| 57 | +## Automated tests |
| 58 | +### What did you run? |
| 59 | +<!-- Examples: `dotnet test`, specific test projects, filters --> |
| 60 | +- Command(s): |
| 61 | + |
| 62 | +### Results |
| 63 | +- [ ] Passed |
| 64 | +- [ ] Failed (explain and link logs) |
| 65 | + |
| 66 | +### Tests added/updated in this PR |
| 67 | +<!-- Briefly list new or updated tests, or write N/A --> |
| 68 | +- |
| 69 | + |
| 70 | +--- |
| 71 | + |
| 72 | +## Manual validation (required for runtime/behavior changes) |
| 73 | +> If this is docs-only or test-only, explain why manual validation is N/A. |
| 74 | +
|
| 75 | +### Environment |
| 76 | +- OS: |
| 77 | +- .NET SDK/runtime version: |
| 78 | +- DurableTask component(s) affected (client/worker/backend/etc.): |
| 79 | + |
| 80 | +### Scenarios executed (check all that apply) |
| 81 | +- [ ] Orchestration start, completion, and replay behavior |
| 82 | +- [ ] Activity execution (including retries) |
| 83 | +- [ ] Failure handling (exceptions, poison messages, transient failures) |
| 84 | +- [ ] Cancellation and termination flows |
| 85 | +- [ ] Timers and long-running orchestration behavior |
| 86 | +- [ ] Concurrency / scale behavior (multiple instances, parallel activities) |
| 87 | +- [ ] Backward compatibility check (old history / upgraded worker) if applicable |
| 88 | +- [ ] Other (describe): |
| 89 | + |
| 90 | +### Steps and observed results (required) |
| 91 | +<!-- Provide exact steps so a reviewer can reproduce. |
| 92 | +Include relevant logs/trace snippets or describe what you observed. --> |
| 93 | +1. |
| 94 | +2. |
| 95 | +3. |
| 96 | + |
| 97 | +Evidence (logs, screenshots, traces, links): |
| 98 | +- |
| 99 | + |
| 100 | +--- |
| 101 | + |
| 102 | +# Compatibility / Breaking changes |
| 103 | + |
| 104 | +- [ ] No breaking changes |
| 105 | +- [ ] Breaking changes (describe below) |
| 106 | + |
| 107 | +If breaking: |
| 108 | +- Impacted APIs/behavior: |
| 109 | +- Migration guidance: |
| 110 | +- Versioning considerations: |
| 111 | + |
| 112 | +--- |
| 113 | + |
| 114 | +# Review checklist (author) |
| 115 | + |
| 116 | +- [ ] Code builds locally |
| 117 | +- [ ] No unnecessary refactors or unrelated formatting changes |
| 118 | +- [ ] Public API changes are justified and documented (XML docs / README / samples as appropriate) |
| 119 | +- [ ] Logging is useful and not noisy (no secrets, no PII) |
| 120 | +- [ ] Error handling follows existing DurableTask patterns |
| 121 | +- [ ] Performance impact considered (hot paths, allocations, I/O) |
| 122 | +- [ ] Security considerations reviewed (input validation, secrets, injection, SSRF, etc.) |
| 123 | + |
| 124 | +--- |
| 125 | + |
| 126 | +# Notes for reviewers |
| 127 | +<!-- Anything that helps reviewers: design notes, tradeoffs, follow-ups, risky areas --> |
| 128 | +- |
0 commit comments