Skip to content

Commit bd8e7d1

Browse files
authored
Revise pull request template for better usability
Updated the pull request template to streamline sections and improve clarity.
1 parent aedc31b commit bd8e7d1

File tree

1 file changed

+36
-100
lines changed

1 file changed

+36
-100
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 36 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,64 @@
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-
81
# Summary
9-
102
## What changed?
11-
<!-- 1 to 5 sentences. What does this PR do? -->
3+
-
124

135
## Why is this change needed?
14-
<!-- Link to bug/feature request and describe the problem being solved. -->
6+
-
157

16-
## Related issues / work items
17-
- Fixes #
8+
## Issues / work items
9+
- Resolves #
1810
- Related #
1911

2012
---
2113

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-
14+
# Project checklist
15+
- [ ] Documentation changes are not required
16+
- [ ] Otherwise: Documentation PR is ready to merge and referenced in `pending_docs.md`
17+
- [ ] Release notes are not required for the next release
18+
- [ ] Otherwise: Notes added to `release_notes.md`
19+
- [ ] Backport is not required
20+
- [ ] Otherwise: Backport tracked by issue/PR #issue_or_pr
21+
- [ ] All required tests have been added/updated (unit tests, E2E tests)
22+
- [ ] Breaking change?
23+
- [ ] If yes:
24+
- Impact:
25+
- Migration guidance:
3226
---
3327

3428
# AI-assisted code disclosure (required)
35-
3629
## Was an AI tool used? (select one)
37-
- [ ] No, this PR was written without AI assistance
30+
- [ ] No
3831
- [ ] Yes, AI helped write parts of this PR (e.g., GitHub Copilot)
3932
- [ ] Yes, an AI agent generated most of this PR
4033

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):
34+
If AI was used:
35+
- Tool(s):
36+
- AI-assisted areas/files:
37+
- What you changed after AI output:
4538

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
39+
AI verification (required if AI was used):
40+
- [ ] I understand the code and can explain it
41+
- [ ] I verified referenced APIs/types exist and are correct
42+
- [ ] I reviewed edge cases/failure paths (timeouts, retries, cancellation, exceptions)
43+
- [ ] I reviewed concurrency/async behavior
44+
- [ ] I checked for unintended breaking or behavior changes
5245

5346
---
5447

5548
# Testing
56-
5749
## Automated tests
58-
### What did you run?
59-
<!-- Examples: `dotnet test`, specific test projects, filters -->
6050
- Command(s):
51+
- Result: Passed / Failed (link logs if failed)
6152

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.)
53+
## Manual validation (only if runtime/behavior changed)
54+
- Environment (OS, .NET version, components):
55+
- Steps + observed results:
56+
1.
57+
2.
58+
3.
59+
- Evidence (optional):
12360

12461
---
12562

12663
# Notes for reviewers
127-
<!-- Anything that helps reviewers: design notes, tradeoffs, follow-ups, risky areas -->
128-
-
64+
- N/A

0 commit comments

Comments
 (0)