Skip to content

Commit 7bc7235

Browse files
authored
enhancement: #7 added templates
2 parents 03047f8 + 9486ed9 commit 7bc7235

File tree

3 files changed

+56
-9
lines changed

3 files changed

+56
-9
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Description
2+
3+
<!-- Please include a summary of the issue.-->
4+
5+
## Type of issue
6+
7+
- [ ] Feature (New Script)
8+
- [ ] Bug
9+
- [ ] Documentation
10+
11+
## Checklist:
12+
13+
- [ ] I have read the project guidelines.
14+
- [ ] I have checked all the existing projects, before submitting a new project issue.
15+
- [ ] I have checked previous issues to avoid duplicates.
16+
- [ ] This issue will be meaningful for the project.
17+
18+
19+
<!-- Uncomment this in case you have a issue related to a bug in existing code.-->
20+
21+
<!--
22+
- [ ] I have added screenshots of the bug
23+
- [ ] I have added steps to reproduce the bug
24+
- [ ] I have proposed a possible solution for the bug
25+
-->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Description
2+
3+
A short summary of what is included in your Pull Request.
4+
5+
Fixes #(issue_no)
6+
7+
Replace `issue_no` in the above line, with the issue related to this PR.
8+
9+
## Type of change
10+
11+
Choosing one or more options from the following as per the nature of your Pull request.
12+
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Documentation Update
16+
17+
# Checklist:
18+
Please tick all the boxes that are fulfilled by your Pull Request.
19+
20+
- [ ] I have named my files and folder, according to this project's guidelines.
21+
- [ ] My code follows the style guidelines of this project.
22+
- [ ] My Pull Request has a descriptive title. (not a vague title like `Update index.md`)
23+
- [ ] I have commented on my code, particularly in hard-to-understand areas.
24+
- [ ] I have created a helpful and easy to understand `README.md`, according to the given [`README_TEMPLATE.`](https://github.com/chavarera/python-mini-projects/blob/master/README_TEMPLATE.md)
25+
- [ ] I have included a requirements.txt file (if external libraries are required.)
26+
- [ ] My changes do not produce any warnings.
27+
- [ ] I have added a working sample/screenshot of the script.

.github/workflows/python-app.yml

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,7 @@ jobs:
3030
- name: Linting with flake8
3131
run: |
3232
pip install flake8
33-
# find only changed *.py files compared to main
34-
CHANGED_FILES=$(git diff --name-only origin/main...HEAD -- '*.py')
35-
if [ -n "$CHANGED_FILES" ]; then
36-
echo "Running flake8 on changed files:"
37-
echo "$CHANGED_FILES"
38-
flake8 $CHANGED_FILES
39-
else
40-
echo "No Python files changed."
41-
fi
33+
# stop the build if there are Python syntax errors or undefined names
34+
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
35+
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
36+
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

0 commit comments

Comments
 (0)