Skip to content

Commit 5b88c4e

Browse files
committed
CLN: Condense PR style checklist into one script
1 parent 40bff2f commit 5b88c4e

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
- [ ] closes #xxxx
22
- [ ] tests added / passed
3-
- [ ] passes `black pandas`
4-
- [ ] passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
3+
- [ ] passes `./scripts/quick_style_check.sh`
54
- [ ] whatsnew entry

scripts/quick_style_check.sh

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#!/usr/bin/env bash
2+
3+
lint_files() {
4+
git diff upstream/master --name-only -u -- "*.py" | xargs -r $1
5+
}
6+
7+
echo "FLAKE8 check: it passes if no errors are reported"
8+
echo ""
9+
10+
lint_files flake8
11+
12+
echo ""
13+
echo "ISORT check: it passes if no files need to be fixed"
14+
echo "If fixes are made, please commit those with your changes"
15+
echo ""
16+
17+
lint_files isort
18+
19+
echo ""
20+
echo "BLACK check: it passes if no files need to be reformatted"
21+
echo "If reformats is done, please commit those with your changes"
22+
23+
lint_files black

0 commit comments

Comments
 (0)