Skip to content

Commit 88a24a9

Browse files
committed
Create Github templates
By using the templates we could guide people to provide necessary information in the expected way, so we may reduce the cost of communication back and forth.
1 parent da4286c commit 88a24a9

File tree

5 files changed

+113
-0
lines changed

5 files changed

+113
-0
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: 🛠 Bug report
3+
about: Create a report to help us improve
4+
title: "[Bug Report] Good bug title tells us about precise symptom, not about the root cause."
5+
labels: "bug"
6+
assignees: ""
7+
---
8+
9+
## Description
10+
<!-- A clear and concise description of what the bug is. -->
11+
12+
## {{ cookiecutter.project_name }} version
13+
<!-- x.y.z or commit hash -->
14+
15+
## Steps to Reproduce
16+
<!--
17+
Steps to reproduce the behavior:
18+
1. Go to '...'
19+
2. Click on '....'
20+
3. Scroll down to '....'
21+
4. See error
22+
-->
23+
24+
## Expected Behavior
25+
<!--
26+
A clear and concise description of what you expected to happen.
27+
28+
**Screenshots**
29+
If applicable, add screenshots to help explain your problem.
30+
-->
31+
32+
## Actual Behavior
33+
<!-- What happens actually so you think this is a bug. -->
34+
35+
## More Information

Diff for: .github/ISSUE_TEMPLATE/documentation.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: 📖 Documentation
3+
about: Suggest an improvement for the documentation of this project
4+
title: "[Documentation] Content to be added or fixed"
5+
labels: "documentation"
6+
assignees: ""
7+
---
8+
9+
## Type
10+
* [ ] Content inaccurate
11+
* [ ] Content missing
12+
* [ ] Typo
13+
14+
## URL
15+
<!-- URL to the code we did not clearly describe or the document page where the content is inaccurate -->
16+
17+
## Description
18+
<!-- A clear and concise description of what content should be added or fixed -->

Diff for: .github/ISSUE_TEMPLATE/feature_request.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: 🚀 Feature request
3+
about: Suggest an idea for this project
4+
title: "[Feature Request] <One feature request per issue>"
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
## Description
10+
<!--A clear and concise description for us to know your idea.-->
11+
12+
## Possible Solution
13+
<!--A clear and concise description of what you want to happen.-->
14+
15+
## Additional context
16+
<!--Add any other context or screenshots about the feature request here.-->
17+
18+
## Related Issue
19+
<!--If applicable, add link to existing issue also help us know better.-->

Diff for: .github/pull_request_template.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!--(Thanks for sending a pull request! Please fill in the following content to let us know better about this change.)-->
2+
3+
## Types of changes
4+
<!--Please remove the types that does not apply to this change-->
5+
6+
- **Bugfix**
7+
- **New feature**
8+
- **Refactoring**
9+
- **Breaking change** (any change that would cause existing functionality to not work as expected)
10+
- **Documentation Update**
11+
- **Other (please describe)**
12+
13+
## Description
14+
<!--Describe what the change is**-->
15+
16+
## Checklist:
17+
- [ ] Add test cases to all the changes you introduce
18+
- [ ] Run `poetry run pytest` locally to ensure all linter checks pass
19+
- [ ] Update the documentation if necessary
20+
21+
## Steps to Test This Pull Request
22+
<!--
23+
Steps to reproduce the behavior:
24+
1. ...
25+
2. ...
26+
3. ...
27+
-->
28+
29+
## Expected behavior
30+
<!--A clear and concise description of what you expected to happen-->
31+
32+
## Related Issue
33+
<!--If applicable, reference to the issue related to this pull request.-->
34+
35+
## Additional context
36+
<!--Add any other context or screenshots about the pull request here.-->

Diff for: README.md

+5
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,8 @@ Today `ubuntu-server-netboot` needs to run on Ubuntu or another Debian derivativ
2525
- python3-distro-info
2626
- pxelinux (x86-only)
2727
- syslinux-common (x86-only)
28+
29+
## Contribution
30+
31+
Please report bugs to [this github issue tracker](https://github.com/dannf/ubuntu-server-netboot/issues). The github templates including "Issue" and "Pull requests" are originally forked from [this "cookiecutter" templates for python](https://github.com/Lee-W/cookiecutter-python-template).
32+

0 commit comments

Comments
 (0)