docs: Update issue and PR templates (#325) (#341)

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]>
celestiaorg · Feb 13, 2023 · ef8f719 · ef8f719
1 parent dafe7fa
commit ef8f719
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 25 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -1,7 +1,7 @@
 ---
 name: Bug Report
 about: Create a report to help us squash bugs!
-
+labels: bug, needs-triage
 ---
 <!--
 Please fill in as much of the template below as you can.
@@ -14,8 +14,13 @@ ask you to provide additional logs and data (CometBFT & App).
 
 -->
 
+## Bug Report
+
+### Setup
+
 **CometBFT version** (use `cometbft version` or `git rev-parse --verify HEAD` if installed from source):
 
+**Have you tried the latest version**: yes/no
 
 **ABCI app** (name for built-in, URL for self-written if it's publicly available):
 
@@ -24,23 +29,54 @@ ask you to provide additional logs and data (CometBFT & App).
 - **Install tools**:
 - **Others**:
 
+**node command runtime flags**:
 
-**What happened**:
+### Config
 
+<!--
 
-**What you expected to happen**:
+You can paste only the changes you've made.
 
+-->
 
-**Have you tried the latest version**: yes/no
+### What happened?
 
-**How to reproduce it** (as minimally and precisely as possible):
+### What did you expect to happen?
 
-**Logs (paste a small part showing an error (< 10 lines) or link a pastebin, gist, etc. containing more of the log file)**:
+### How to reproduce it
 
-**Config (you can paste only the changes you've made)**:
+<!--
 
-**node command runtime flags**:
+Provide a description here as minimally and precisely as possible as to how to
+reproduce the issue. Ideally only using our kvstore application, as debugging
+app chains is not within our team's scope.
+
+-->
+
+### Logs
+
+<!--
 
-**Please provide the output from the `http://<ip>:<port>/dump_consensus_state` RPC endpoint for consensus bugs**
+Paste a small part showing an error (< 10 lines) or link a pastebin, gist, etc.
+containing more of the log file).
+
+-->
+
+### `dump_consensus_state` output
+
+<!--
+
+Please provide the output from the `http://<ip>:<port>/dump_consensus_state` RPC
+endpoint for consensus bugs.
+
+-->
+
+### Anything else we need to know
+
+<!--
+
+Is there any additional information not covered by the other sections that would
+help us to triage/debug/fix this issue?
+
+-->
 
-**Anything else we need to know**:
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -1,7 +1,7 @@
 ---
 name: Feature Request
 about: Create a proposal to request a feature
-
+labels: enhancement, needs-triage
 ---
 
 <!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺ 
@@ -11,18 +11,20 @@ v    Word of caution: poorly thought-out proposals may be rejected
 v                     without deliberation 
 ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > >  -->
 
-## Summary
+## Feature Request
+
+### Summary
 
 <!-- Short, concise description of the proposed feature -->
 
-## Problem Definition
+### Problem Definition
 
-<!-- Why do we need this feature? 
+<!-- Why do we need this feature?
 What problems may be addressed by introducing this feature?
 What benefits does CometBFT stand to gain by including this feature?
 Are there any disadvantages of including this feature? -->
 
-## Proposal
+### Proposal
 
 <!-- Detailed description of requirements of implementation -->
 

diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md
@@ -1,7 +1,7 @@
 ---
 name: Protocol Change Proposal
 about: Create a proposal to request a change to the protocol
-
+labels: protocol-change, needs-triage
 ---
 
 <!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺ 
@@ -10,20 +10,20 @@ v    Before smashing the submit button please review the template.
 v    Word of caution: Under-specified proposals may be rejected summarily 
 ☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > >  -->
 
-# Protocol Change Proposal
+## Protocol Change Proposal
 
-## Summary
+### Summary
 
 <!-- Short, concise description of the proposed change -->
 
-## Problem Definition
+### Problem Definition
 
-<!-- Why do we need this change? 
+<!-- Why do we need this change?
 What problems may be addressed by introducing this change?
 What benefits does CometBFT stand to gain by including this change?
 Are there any disadvantages of including this change? -->
 
-## Proposal
+### Proposal
 
 <!-- Detailed description of requirements of implementation -->
 

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -24,8 +24,8 @@ https://github.com/orgs/cometbft/projects/1
 
 #### PR checklist
 
-- [ ] Tests written/updated, or no tests needed
-- [ ] `CHANGELOG_PENDING.md` updated, or no changelog entry needed
-- [ ] Updated relevant documentation (`docs/`) and code comments, or no
-      documentation updates needed
+- [ ] Tests written/updated
+- [ ] Changelog entry added in `.changelog` (we use
+  [unclog](https://github.com/informalsystems/unclog) to manage our changelog)
+- [ ] Updated relevant documentation (`docs/` or `spec/`) and code comments
 
diff --git a/.github/issue_template.md b/.github/issue_template.md
@@ -1,3 +1,7 @@
+---
+labels: needs-triage
+---
+
 <!--
 
 If you want to ask a general question, please create a new discussion instead of