8000 docs: Update issue and PR templates by thanethomson · Pull Request #325 · cometbft/cometbft · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: Update issue and PR templates #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 46 additions & 10 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Bug report
about: Create a report to help us squash bugs!

labels: bug, needs-triage
---
<!--

Expand All @@ -15,8 +15,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):

Expand All @@ -25,23 +30,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**:
12 changes: 7 additions & 5 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Feature request
about: Create a proposal to request a feature

labels: enhancement, needs-triage
---

<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
Expand All @@ -11,17 +11,19 @@ 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 -->
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/proposal.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Protocol change proposal
about: Create a proposal to request a change to the protocol

labels: protocol-change, needs-triage
---

<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
Expand All @@ -10,19 +10,19 @@ 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 -->
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,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

4 changes: 4 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
labels: needs-triage
---

<!--

If you want to ask a general question, please create a new discussion instead of
Expand Down
0