Skip to content

Commit 3b7ef9d

Browse files
authored
Add issue and pull request templates for better contribution guidelines (#27)
1 parent 3929eb4 commit 3b7ef9d

File tree

3 files changed

+98
-0
lines changed

3 files changed

+98
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
## Describe the bug
10+
11+
- A clear and concise description of what the bug is.
12+
13+
## To Reproduce
14+
15+
- Steps to reproduce the behavior:
16+
17+
1. Go to '...'
18+
2. Click on '....'
19+
3. Scroll down to '....'
20+
4. See error
21+
22+
## Expected behavior
23+
24+
- A clear and concise description of what you expected to
25+
happen.
26+
27+
## Screenshots
28+
29+
- If applicable, add screenshots to help explain your problem.
30+
31+
## Desktop (please complete the following information)
32+
33+
- OS: [e.g. iOS]
34+
- Browser [e.g. chrome, safari]
35+
- Version [e.g. 22]
36+
37+
## Mobile (please complete the following information)
38+
39+
- Device: [e.g. iPhone6]
40+
- OS: [e.g. iOS8.1]
41+
- Browser [e.g. stock browser, safari]
42+
- Version [e.g. 22]
43+
44+
## Additional context
45+
46+
- Add any other context about the problem here.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
## Is your feature request related to a problem? Please describe
10+
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+
15+
- A clear and concise description of what you want to happen.
16+
17+
## Describe alternatives you've considered
18+
19+
- A clear and concise description of any alternative solutions or features you've considered.
20+
21+
## Additional context
22+
23+
- Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Pull Request Description
2+
3+
## Brief Description of Changes
4+
5+
Briefly explain the overall purpose of the changes made by this pull request.
6+
7+
## Detailed Changes
8+
9+
Please explain in detail the changes made by this pull request. Concisely present what each modification does.
10+
11+
## Objective of Changes/Issue Resolved (if applicable)
12+
13+
Precisely describe the objective of this pull request. Explain why these changes are necessary and how they enhance or resolve specific issues. Use tags like "Fixes #issue-number" or "Resolves the problem of [description]" if applicable.
14+
15+
## Screenshots (if applicable)
16+
17+
If relevant, include screenshots or animated gifs to visually illustrate the changes made.
18+
19+
## Verification Steps
20+
21+
Provide detailed steps that the reviewer can follow to verify your changes:
22+
23+
1. Step 1...
24+
2. Step 2...
25+
3. etc.
26+
27+
## Notes for Reviewer
28+
29+
Include here any relevant additional information or specific points the reviewer should focus on when reviewing this pull request.

0 commit comments

Comments
 (0)