Skip to content

Commit dc22448

Browse files
docs: Update issue and PR templates (tendermint#325) (tendermint#340)
This does a few things: 1. Automatically applies relevant labels on new issues/PRs as users submit them. 2. Cleans up and syncs the structure of all of the issue templates. 3. Updates the PR template to remind folks to use `unclog` format when submitting changelog entries. Templates rendered: - [Bug report](https://github.com/cometbft/cometbft/blob/thane/324-update-issue-pr-templates/.github/ISSUE_TEMPLATE/bug-report.md) - [Feature request](https://github.com/cometbft/cometbft/blob/thane/324-update-issue-pr-templates/.github/ISSUE_TEMPLATE/feature-request.md) - [Protocol change proposal](https://github.com/cometbft/cometbft/blob/thane/324-update-issue-pr-templates/.github/ISSUE_TEMPLATE/proposal.md) - [Pull request template](https://github.com/cometbft/cometbft/blob/thane/324-update-issue-pr-templates/.github/PULL_REQUEST_TEMPLATE.md) --- #### PR checklist - [x] Tests written/updated, or no tests needed - [x] `CHANGELOG_PENDING.md` updated, or no changelog entry needed - [x] Updated relevant documentation (`docs/`) and code comments, or no documentation updates needed (cherry picked from commit 3dd985b) Co-authored-by: Thane Thomson <[email protected]>
1 parent a51c8f9 commit dc22448

File tree

5 files changed

+67
-25
lines changed

5 files changed

+67
-25
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 46 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Bug report
33
about: Create a report to help us squash bugs!
4-
4+
labels: bug, needs-triage
55
---
66
<!--
77
@@ -15,8 +15,13 @@ ask you to provide additional logs and data (CometBFT & App).
1515
1616
-->
1717

18+
## Bug Report
19+
20+
### Setup
21+
1822
**CometBFT version** (use `cometbft version` or `git rev-parse --verify HEAD` if installed from source):
1923

24+
**Have you tried the latest version**: yes/no
2025

2126
**ABCI app** (name for built-in, URL for self-written if it's publicly available):
2227

@@ -25,23 +30,54 @@ ask you to provide additional logs and data (CometBFT & App).
2530
- **Install tools**:
2631
- **Others**:
2732

33+
**node command runtime flags**:
2834

29-
**What happened**:
35+
### Config
3036

37+
<!--
3138
32-
**What you expected to happen**:
39+
You can paste only the changes you've made.
3340
41+
-->
3442

35-
**Have you tried the latest version**: yes/no
43+
### What happened?
3644

37-
**How to reproduce it** (as minimally and precisely as possible):
45+
### What did you expect to happen?
3846

39-
**Logs (paste a small part showing an error (< 10 lines) or link a pastebin, gist, etc. containing more of the log file)**:
47+
### How to reproduce it
4048

41-
**Config (you can paste only the changes you've made)**:
49+
<!--
4250
43-
**node command runtime flags**:
51+
Provide a description here as minimally and precisely as possible as to how to
52+
reproduce the issue. Ideally only using our kvstore application, as debugging
53+
app chains is not within our team's scope.
54+
55+
-->
56+
57+
### Logs
58+
59+
<!--
4460
45-
**Please provide the output from the `http://<ip>:<port>/dump_consensus_state` RPC endpoint for consensus bugs**
61+
Paste a small part showing an error (< 10 lines) or link a pastebin, gist, etc.
62+
containing more of the log file).
63+
64+
-->
65+
66+
### `dump_consensus_state` output
67+
68+
<!--
69+
70+
Please provide the output from the `http://<ip>:<port>/dump_consensus_state` RPC
71+
endpoint for consensus bugs.
72+
73+
-->
74+
75+
### Anything else we need to know
76+
77+
<!--
78+
79+
Is there any additional information not covered by the other sections that would
80+
help us to triage/debug/fix this issue?
81+
82+
-->
4683

47-
**Anything else we need to know**:
Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Feature request
33
about: Create a proposal to request a feature
4-
4+
labels: enhancement, needs-triage
55
---
66

77
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
@@ -11,17 +11,19 @@ v Word of caution: poorly thought-out proposals may be rejected
1111
v without deliberation
1212
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->
1313

14-
## Summary
14+
## Feature Request
15+
16+
### Summary
1517

1618
<!-- Short, concise description of the proposed feature -->
1719

18-
## Problem Definition
20+
### Problem Definition
1921

20-
<!-- Why do we need this feature?
22+
<!-- Why do we need this feature?
2123
What problems may be addressed by introducing this feature?
2224
What benefits does CometBFT stand to gain by including this feature?
2325
Are there any disadvantages of including this feature? -->
2426

25-
## Proposal
27+
### Proposal
2628

2729
<!-- Detailed description of requirements of implementation -->

.github/ISSUE_TEMPLATE/proposal.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Protocol change proposal
33
about: Create a proposal to request a change to the protocol
4-
4+
labels: protocol-change, needs-triage
55
---
66

77
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
@@ -10,19 +10,19 @@ v Before smashing the submit button please review the template.
1010
v Word of caution: Under-specified proposals may be rejected summarily
1111
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->
1212

13-
# Protocol Change Proposal
13+
## Protocol Change Proposal
1414

15-
## Summary
15+
### Summary
1616

1717
<!-- Short, concise description of the proposed change -->
1818

19-
## Problem Definition
19+
### Problem Definition
2020

21-
<!-- Why do we need this change?
21+
<!-- Why do we need this change?
2222
What problems may be addressed by introducing this change?
2323
What benefits does CometBFT stand to gain by including this change?
2424
Are there any disadvantages of including this change? -->
2525

26-
## Proposal
26+
### Proposal
2727

2828
<!-- Detailed description of requirements of implementation -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ https://github.com/orgs/cometbft/projects/1
2525

2626
#### PR checklist
2727

28-
- [ ] Tests written/updated, or no tests needed
29-
- [ ] `CHANGELOG_PENDING.md` updated, or no changelog entry needed
30-
- [ ] Updated relevant documentation (`docs/`) and code comments, or no
31-
documentation updates needed
28+
- [ ] Tests written/updated
29+
- [ ] Changelog entry added in `.changelog` (we use
30+
[unclog](https://github.com/informalsystems/unclog) to manage our changelog)
31+
- [ ] Updated relevant documentation (`docs/` or `spec/`) and code comments
3232

.github/issue_template.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
labels: needs-triage
3+
---
4+
15
<!--
26
37
If you want to ask a general question, please create a new discussion instead of

0 commit comments

Comments
 (0)