Skip to content

Commit 5df9681

Browse files
committed
[docs] Added issue and PR templates
1 parent 969fcd6 commit 5df9681

File tree

4 files changed

+81
-0
lines changed

4 files changed

+81
-0
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report
3+
about: Open a bug report
4+
title: "[bug] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of the bug or unexpected behavior.
12+
13+
**Steps To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**System Informatioon:**
27+
- OS: [e.g. Ubuntu 24.04 LTS]
28+
- Python Version: [e.g. Python 3.11.2]
29+
- Django Version: [e.g. Django 4.2.5]
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[feature] "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
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 [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: Question
3+
about: Please use the Discussion Forum to ask questions
4+
title: "[question] "
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
Please use the [Discussion Forum](https://github.com/openwisp/django-swappable-models/discussions) to ask questions.
11+
12+
We will take care of moving the discussion to a more relevant repository if needed.

.github/pull_request_template.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Checklist
2+
3+
- [ ] I have read the [OpenWISP Contributing Guidelines](http://openwisp.io/docs/developer/contributing.html).
4+
- [ ] I have manually tested the changes proposed in this pull request.
5+
- [ ] I have written new test cases for new code and/or updated existing tests for changes to existing code.
6+
- [ ] I have updated the documentation.
7+
8+
## Reference to Existing Issue
9+
10+
Closes #<issue-number>.
11+
12+
Please [open a new issue](https://github.com/openwisp/django-swappable-models/issues/new/choose) if there isn't an existing issue yet.
13+
14+
## Description of Changes
15+
16+
Please describe these changes.
17+
18+
## Screenshot
19+
20+
Please include any relevant screenshots.

0 commit comments

Comments
 (0)