Skip to content

Commit

Permalink
docs: added issue and PR template (#99)
Browse files Browse the repository at this point in the history
* docs: added issue templates

* Update custom.md

* docs: added PR template

* docs: re-org templates

[skip ci]
  • Loading branch information
chgl authored Sep 16, 2024
1 parent a9a6e0a commit 4d53637
Show file tree
Hide file tree
Showing 5 changed files with 91 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: ""
assignees: ""
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
1. Click on '....'
1. Scroll down to '....'
1. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Server (please complete the following information):**

- OS: [e.g. Ubuntu 24.04]
- Container Runtime [e.g. docker, containerd, cri-o, podman]
- Container Runtime Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest an idea for this project
title: ""
labels: ""
assignees: ""
---

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

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/3-custom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: Custom issue template
about: For anything that isn't a bug or feature request.
title: ""
labels: ""
assignees: ""
---
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull-request-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Describe your changes

<!-- It's OK to be brief. Or skip this entirely if the changes are obvious. -->

## Issue ticket number and link

<!-- Optional -->

## Checklist before requesting a review

<!-- It's OK not to update the documentation or create new tests if deemed unnecessary -->

- [ ] The commit message follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have made corresponding changes to the documentation
17 changes: 17 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"MD004": false,
"MD007": {
"indent": 2
},
"MD013": {
"line_length": 400
},
"MD026": {
"punctuation": ".,;:!。,;:"
},
"MD029": false,
"MD033": false,
"MD036": false,
"blank_lines": false,
"MD041": false
}

0 comments on commit 4d53637

Please sign in to comment.