Skip to content

Commit a35abc0

Browse files
Add templates for issue reporting and PR. (#101)
1 parent b26a8a2 commit a35abc0

5 files changed

Lines changed: 130 additions & 0 deletions

File tree

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: ["bug", "triage"]
6+
assignees: ''
7+
8+
---
9+
10+
## Describe the bug
11+
12+
<!--A clear and concise description of what the bug is.-->
13+
14+
## Version, Tool-chain, Operating System
15+
16+
<!--Use `enca --version` and `gcc -v`-->
17+
18+
```
19+
<!--Replace with output of commands-->
20+
```
21+
22+
## Steps to reproduce
23+
24+
<!--Exact steps in sequential order to trigger the bug.-->
25+
26+
## Expected behavior
27+
28+
<!--A clear and concise description of what you expected to happen.-->
29+
30+
## Actual behaviour
31+
32+
<!--A clear and concise description of what actually happens.-->
33+
34+
## Screenshots/Logs
35+
36+
<!--If applicable, add screenshots to help explain your problem.-->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# check https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
2+
3+
blank_issues_enabled: false
4+
contact_links:
5+
- name: enca documentation
6+
url: https://ossrevival.org/enca/
7+
about: Check the documentation, before asking questions.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[ENH] "
5+
labels: ["enhancement", "triage"]
6+
assignees: ''
7+
8+
---
9+
10+
## Is your feature request related to a problem?
11+
12+
<!--A clear and concise description of what the problem is. Ex. Support new language encoding.-->
13+
14+
## Version, Tool-chain, Operating System
15+
16+
Use `enca --version` and `gcc -v`
17+
18+
```
19+
<!--Replace with output of commands-->
20+
```
21+
22+
## Describe the solution you'd like
23+
24+
<!--A clear and concise description of what you want to happen.-->
25+
26+
## Steps to reproduce (if applicable)
27+
28+
<!--Steps to reproduce the current behavior or proposed steps to implement.-->
29+
30+
## Expected behavior (if applicable)
31+
32+
<!--A clear and concise description of what you expected to happen.-->
33+
34+
## Actual behaviour (if applicable)
35+
36+
<!--A clear and concise description of what actually happens.-->
37+
38+
## Describe alternatives you've considered
39+
40+
<!--A clear and concise description of any alternative solutions or features you've considered.-->
41+
42+
## Additional context
43+
44+
<!--Add any other context or screenshots to help explain your feature.-->

.github/ISSUE_TEMPLATE/support.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Question or support request
3+
about: You're puzzled or something doesn't work as expected
4+
title: "[?] "
5+
labels: ["support", "triage"]
6+
assignees: ''
7+
8+
---
9+
10+
## What is the issue?
11+
12+
<!--A clear and concise description of what you need help with.-->
13+
14+
## Version, Tool-chain, Operating System
15+
16+
Use `enca --version` and `gcc -v`
17+
18+
```
19+
<!--Replace with output of commands-->
20+
```
21+
22+
## Steps you have already tried
23+
24+
<!--Describe any troubleshooting steps you've already taken.-->
25+
26+
## Additional context
27+
28+
<!--Add any other context or screenshots to help explain your feature.-->

.github/pull_request_template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Description
2+
<!-- Briefly describe the change and its purpose. If the change does not relates to a Github issue please provide step to reproduce the issue which PR fixes if required. -->
3+
4+
## Related Ticket
5+
<!-- Link to GitHub issue (e.g., Fixes #123) -->
6+
7+
## Type of Change
8+
- [ ] Bug fix
9+
- [ ] New feature
10+
- [ ] Breaking change
11+
- [ ] Documentation update
12+
13+
## Checklist
14+
- [ ] I have performed a self-review of my code
15+
- [ ] Documentation updated

0 commit comments

Comments
 (0)