Skip to content

Commit bb4a10f

Browse files
committed
update template
1 parent 331e36d commit bb4a10f

File tree

5 files changed

+48
-36
lines changed

5 files changed

+48
-36
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,36 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
## Bug description
1211

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
12+
<!-- A clear and concise description of what the bug is. -->
1513

14+
## To Reproduce
15+
16+
<!--
17+
Steps to reproduce the behavior. Something like:
1618
1. Go to '...'
1719
2. Click on '....'
1820
3. Scroll down to '....'
1921
4. See error
22+
-->
23+
24+
## Expected behavior
25+
26+
<!-- A clear and concise description of what you expected to happen. -->
2027

21-
**Expected behavior**
22-
A clear and concise description of what you expected to happen.
28+
## Screenshots
2329

24-
**Screenshots**
25-
If applicable, add screenshots to help explain your problem.
30+
<!-- If applicable, add screenshots to help explain your problem. -->
2631

27-
**Desktop (please complete the following information):**
32+
## Environment
33+
34+
<!-- Please fill the following information. -->
2835

2936
- OS: [e.g. iOS]
3037
- Browser [e.g. chrome, safari]
3138
- Version [e.g. 22]
3239

33-
**Additional context**
34-
Add any other context about the problem here.
40+
## Additional context
41+
42+
<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,21 @@ assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
## Problem
1211

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
12+
<!--
13+
If your feature request is related to a problem, please describe it.
14+
Ex. I hate when [...]
15+
-->
1516

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
17+
## Solution
1818

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
19+
<!-- Describe the solution you'd like. -->
20+
21+
## Alternatives
22+
23+
<!-- Describe any alternative solutions or features you've considered. -->
24+
25+
## Additional context
26+
27+
<!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
1-
## Description
2-
3-
Please explain the changes you made here.
4-
5-
## Checklist
6-
7-
- [ ] I have read
8-
[CONTRIBUTING](https://github.com/rust-github/rust-gh-example/blob/master/docs/CONTRIBUTING.md)
9-
guidelines.
10-
- [ ] I have formatted the code using [rustfmt](https://github.com/rust-lang/rustfmt)
11-
- [ ] I have checked that all tests pass, by running `cargo test --all`
12-
13-
#### [CHANGELOG](https://github.com/rust-github/rust-gh-example/blob/master/CHANGELOG.md):
14-
15-
- [ ] Updated
16-
- [ ] I will update it after this PR has been discussed
17-
- [ ] No need to update
1+
<!-- Please explain the changes you made -->
2+
3+
<!--
4+
Please, make sure:
5+
- you have read the contributing guidelines:
6+
https://github.com/rust-github/rust-gh-example/blob/master/docs/CONTRIBUTING.md
7+
- you have formatted the code using rustfmt:
8+
https://github.com/rust-lang/rustfmt
9+
- you have checked that all tests pass, by running `cargo test --all`
10+
- you have updated the changelog (if needed):
11+
https://github.com/rust-github/rust-gh-example/blob/master/CHANGELOG.md
12+
-->

.github/workflows/audit.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ jobs:
1919
- uses: actions-rs/audit-check@v1
2020
with:
2121
token: ${{ secrets.GITHUB_TOKEN }}
22+

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,4 @@ jobs:
7979
with:
8080
github-token: ${{ secrets.GITHUB_TOKEN }}
8181
path-to-lcov: './lcov.info'
82+

0 commit comments

Comments
 (0)