Skip to content

Commit 6cd205b

Browse files
Add pull request template (#8)
1 parent e145d35 commit 6cd205b

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<!--
2+
### Contribution Checklist
3+
4+
- PR title format should be *[type][component] summary*. For details, see *[Guideline - Pulsar PR Naming Convention](https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.trs9rsex3xom)*.
5+
6+
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
7+
8+
- Each pull request should address only one issue, not mix up code from multiple issues.
9+
10+
- Each commit in the pull request has a meaningful commit message
11+
12+
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
13+
-->
14+
15+
<!-- Either this PR fixes an issue, -->
16+
17+
Fixes #<xyz>
18+
19+
<!-- or this PR is one task of an issue -->
20+
21+
Master Issue: #<xyz>
22+
23+
### Motivation
24+
25+
<!-- Explain here the context, and why you're making that change. What is the problem you're trying to solve. -->
26+
27+
### Modifications
28+
29+
<!-- Describe the modifications you've done. -->
30+
31+
### Verifying this change
32+
33+
- [ ] Make sure that the change passes the CI checks.
34+
35+
*(Please pick either of the following options)*
36+
37+
This change is a trivial rework / code cleanup without any test coverage.
38+
39+
*(or)*
40+
41+
This change is already covered by existing tests, such as *(please describe tests)*.
42+
43+
*(or)*
44+
45+
This change added tests and can be verified as follows:
46+
47+
*(example:)*
48+
- *Added integration tests for end-to-end deployment with large payloads (10MB)*
49+
- *Extended integration test for recovery after broker failure*
50+
51+
### Documentation
52+
53+
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
54+
55+
- [ ] `doc-required`
56+
(Your PR needs to update docs and you will update later)
57+
58+
- [ ] `doc-not-needed`
59+
(Please explain why)
60+
61+
- [ ] `doc`
62+
(Your PR contains doc changes)
63+
64+
- [ ] `doc-complete`
65+
(Docs have been already added)

0 commit comments

Comments
 (0)