Skip to content

Commit

Permalink
modify the github templates
Browse files Browse the repository at this point in the history
chore: update proposal

chore: add write adr template

chore: add implement feature template

chore: add refs to spec

chore: minor change to proposal

Update .github/ISSUE_TEMPLATE/write-adr.md

Co-authored-by: John Adler <[email protected]>

chore: remove a few lines from bug report
  • Loading branch information
liamsi authored and evan-forbes committed May 3, 2022
1 parent 6d2f659 commit 0ac8bdf
Show file tree
Hide file tree
Showing 5 changed files with 126 additions and 49 deletions.
16 changes: 3 additions & 13 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,7 @@ Be ready for followup questions, and please respond in a timely
manner. We might ask you to provide additional logs and data (tendermint & app).
-->

**Tendermint version** (use `tendermint version` or `git rev-parse --verify HEAD` if installed from source):


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

**Environment**:
- **OS** (e.g. from /etc/os-release):
- **Install tools**:
- **Others**:
**Version** (use `git rev-parse --verify HEAD`):


**What happened**:
Expand All @@ -27,16 +19,14 @@ manner. We might ask you to provide additional logs and data (tendermint & app).
**What you expected to happen**:


**Have you tried the latest version**: yes/no

**How to reproduce it** (as minimally and precisely as possible):

**Logs (paste a small part showing an error (< 10 lines) or link a pastebin, gist, etc. containing more of the log file)**:

**Config (you can paste only the changes you've made)**:
**Config (you can paste only the changes you've made to the config)**:

**node command runtime flags**:

**Please provide the output from the `http://<ip>:<port>/dump_consensus_state` RPC endpoint for consensus bugs**

**Anything else we need to know**:
**Anything else**:
36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/implement-feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Actionable implementation task
about: A well-defined, already decided-on, actionable implementation task.

---

## Summary

<!-- Short, concise description of what feature the implementation will cover -->

## Details

<!--
Particularly if this implementation was not already discussed in a Proposal issue,
or even in an ADR, please include as many details as possible about what this
implementation task covers.
Also cover WHY this is needed!
-->

### Action Items
<!-- Short, concise list of actionable sub-tasks -->
- [ ] sub-task 1
<!-- open issues for sub-tasks where it makes sense
rule of thumb: is a sub-task more than 1-2 days of work? -> requires own issue -->

### References

<!--
Add references and all relations to:
- other issues
- particularly Proposals (if applicable)
- Important: related tracking issue!
- other pull requests
- discussions
- and ADRs
examples:
blocked by: #XXX
depends on: #XXX
implements ADR: link to ADR
included in: #link to tracking issue
reference to specification: perma-link to spec
-->

35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: proposal
about: Propose an improvement, feature, or change to core components

---

<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v ✰ Thanks for proposing an improvement or feature! ✰
v Before smashing the submit button please review the template.
v Word of caution: poorly thought-out proposals may be rejected
v without deliberation
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->

## Summary

<!-- Short, concise description of the proposed feature / change -->

## Problem Definition

<!-- Why do we need this feature?
What problems may be addressed by introducing this feature?
What benefits does we gain by including this feature?
Are there any disadvantages of including this feature? -->

## Proposal

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

### Implementation

<!-- Include details on how the implementation would look like -->
<!-- Point to branches, draft PRs with spike, proof of concept or tracer implementations -->

<!-- If the change is large, how will the changes be broken up for ease of review? -->

43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/write-adr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: ADR
about: Write an ADR for certain aspect of the system

---

## Summary

<!-- Short, concise description of what this ADR should cover -->

## Details

<!-- Add more details about the nature of this ADR -->

<!-- Jot down expectations as clearly as possible
Does this ADR cover changes to:
- public API?
- changes to Tendermint core types?
- the p2p networking layer?
- storage?
- user interface?
- some other core component (mempool, gossiping etc)
-->

<!--
If this ADR is part of some time critical, urgent feature, please be
explicit about this in the issue already.
This will help guiding the author on decision for the implementation plan.
-->

## References and Context

<!-- Usually, before we decide to write ADR about a certain aspect,
there are pre-existing:
- reference to specification (perma-link to spec)
- discussions
- issues (e.g. Proposals)
- or even draft PRs.
Make sure to link those here to facilitate writing the ADR and
to give the author all required context (this can be helpful even
if you are the author yourself).
-->

0 comments on commit 0ac8bdf

Please sign in to comment.