From 870c325e3c247cdec5aa61cdaa5ecbeb1aec1f64 Mon Sep 17 00:00:00 2001 From: MinchinWeb Date: Sat, 2 May 2020 13:06:23 -0600 Subject: [PATCH] GitHub Pull Request Template Update (#927) * Improve GitHub PR Template * suggest running commands with `poetry run ...` pyflakes here is given only certain subdirectories because `.` will try and run across all packages installed in the virtual environment, if the virtual environment is within the project's root folder (which is my common practice). --- .github/PULL_REQUEST_TEMPLATE.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 986f10ee..49533409 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,8 @@ + + ### Checklist + - [ ] The code change is tested and works locally. -- [ ] Tests pass. Your PR cannot be merged unless tests pass +- [ ] Tests pass. Your PR cannot be merged unless tests pass. -- + `poetry run behave` +- [ ] The code passes linting via + [black](https://black.readthedocs.io/en/stable/) (consistent code styling). -- + `poetry run black --check . --verbose --diff` +- [ ] The code passes linting via [pyflakes](https://launchpad.net/pyflakes) + (logically errors and unused imports). -- `poetry run pyflakes jrnl features` - [ ] There is no commented out code in this PR. - [ ] Have you followed the guidelines in our Contributing document? -- [ ] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change? -- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? +- [ ] Have you checked to ensure there aren't other open + [Pull Requests](../pulls) for the same update/change? +- [ ] Have you added an explanation of what your changes do and why you'd like + us to include them? - [ ] Have you written new tests for your core changes, as applicable?