Skip to content

Commit 4eaf7c8

Browse files
authored
Merge pull request #321 from rustaceanrob/issue-templates
Add issue templates for bugs, features, and releases
2 parents a7118a7 + 11e5e03 commit 4eaf7c8

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
<!-- A clear and concise description of what the bug is. -->
12+
13+
**To Reproduce**
14+
<!-- Steps or code to reproduce the behavior. -->
15+
16+
**Expected behavior**
17+
<!-- A clear and concise description of what you expected to happen. -->
18+
19+
**Build environment**
20+
- Tag/commit: <!-- e.g. v0.13.0, 3a07614 -->
21+
- OS+version: <!-- e.g. ubuntu 20.04.01, macOS 12.0.1, windows -->
22+
- Rust/Cargo version: <!-- e.g. 1.56.0 -->
23+
- Rust/Cargo target: <!-- e.g. x86_64-apple-darwin, x86_64-unknown-linux-gnu, etc. -->
24+
25+
**Additional context**
26+
<!-- Add any other context about the problem here. -->
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Enhancement request
3+
about: Request a new feature or change to an existing feature
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the enhancement**
11+
<!-- A clear and concise description of what you would like added or changed. -->
12+
13+
**Use case**
14+
<!-- Tell us how you or others will use this new feature or change to an existing feature. -->
15+
16+
**Additional context**
17+
<!-- Add any other context about the enhancement here. -->

.github/ISSUE_TEMPLATE/release.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Release
3+
about: Create a new release [for release managers only]
4+
title: 'Release MAJOR.MINOR.PATCH'
5+
labels: 'release'
6+
assignee
7+
---
8+
9+
**Steps**
10+
11+
- [ ] Update the Kyoto version contained in the User Agent of the P2P Version message.
12+
- [ ] Update the changelog with the recent commit history.
13+
- [ ] Check the documentation for errors using `cargo +nightly doc --open`
14+
- [ ] Increase the version number in `Cargo.toml` according to semver
15+
- [ ] Attempt a publish dry-run using `cargo publish --dry-run`
16+
- [ ] Create a pull request and ensure all tests pass
17+
- [ ] Merge the pull request and publish from `master`
18+

0 commit comments

Comments
 (0)