Skip to content

Commit 849fc41

Browse files
committed
adding templates for PR and Issues
1 parent 8cbc9bf commit 849fc41

8 files changed

+188
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**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+
**Additional context**
27+
Add any other context about the problem here.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Documentation Request
3+
about: Suggest changes or additions to the project documentation
4+
title: "[Documentation] "
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
**What documentation needs to be updated?**
11+
A clear and concise description of the documentation that needs to be updated.
12+
13+
**Describe the changes needed**
14+
What specific changes or additions do you propose?
15+
16+
**Additional context**
17+
Add any other context about the documentation request here.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Enhancement Request
3+
about: Suggest an improvement or enhancement for the project
4+
title: "[Enhancement] "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the enhancement**
11+
A clear and concise description of the proposed enhancement or improvement.
12+
13+
**Why is this enhancement necessary?**
14+
Explain why this enhancement would be beneficial for the project.
15+
16+
**Proposed solution**
17+
Describe how you would implement this enhancement.
18+
19+
**Alternatives considered**
20+
If applicable, mention any alternative solutions you've considered.
21+
22+
**Additional context**
23+
Add any other context or screenshots related to the enhancement here.
+20
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 the problem you're trying to solve.
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.
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Test Request
3+
about: Request to add or modify tests for the project
4+
title: "[Test] "
5+
labels: test
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the test request**
11+
A clear and concise description of what you want to test or modify in the existing tests.
12+
13+
**Motivation**
14+
Explain why this test is important.
15+
16+
**Steps to Reproduce**
17+
Provide any relevant steps or code snippets.
18+
19+
**Additional context**
20+
Add any other context about the test request here.
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Workflow Request
3+
about: Suggest changes to the project's workflow or process
4+
title: "[Workflow] "
5+
labels: workflow
6+
assignees: ''
7+
8+
---
9+
10+
**What workflow needs to be updated?**
11+
A clear and concise description of the workflow that needs to be updated.
12+
13+
**Describe the proposed changes**
14+
What specific changes do you propose for the workflow?
15+
16+
**Motivation**
17+
Explain why this change is necessary.
18+
19+
**Additional context**
20+
Add any other context about the workflow request here.

.github/PULL_REQUEST_TEMPLATE.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Description
2+
3+
Please include a summary of the change and which issue is fixed. Also include relevant motivation and context.
4+
5+
- Fixes #(issue number)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
- [ ] Tests update
16+
17+
## Checklist
18+
19+
- [ ] My code follows the style guidelines of this project
20+
- [ ] I have performed a self-review of my own code
21+
- [ ] I have commented my code, particularly in hard-to-understand areas
22+
- [ ] My changes generate no new warnings
23+
- [ ] New and existing unit tests pass locally with my changes
24+
- [ ] I have maintained a clean commit history by using the necessary Git commands
25+
- [ ] I have checked that my code does not cause any merge conflicts
26+
27+
## Screenshots (if applicable)
28+
29+
Add screenshots to help explain the changes (if necessary).

.github/workflows/test.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Run Tests
2+
3+
on:
4+
push:
5+
branches:
6+
- '**'
7+
pull_request:
8+
branches:
9+
- '**'
10+
11+
jobs:
12+
test:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v2
18+
19+
- name: Set up Python
20+
uses: actions/setup-python@v2
21+
with:
22+
python-version: '3.8'
23+
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install poetry
28+
poetry install
29+
30+
- name: Run tests
31+
run: |
32+
poetry run pytest tests/*.py

0 commit comments

Comments
 (0)