From 2b70409b33edf06cc42f0f8ccc51cc2a97440696 Mon Sep 17 00:00:00 2001 From: Jose Jaime Date: Wed, 15 Jan 2025 20:10:59 -0800 Subject: [PATCH] Update PULL_REQUEST_TEMPLATE.md Add note on using a diff checker when running `pylint` --- .github/PULL_REQUEST_TEMPLATE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9b1ac4de..af51f4ed 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,6 +11,8 @@ - \[ \] `pre-commit run --all-files` - \[ \] Run your code through [pylint](https://pylint.readthedocs.io/en/latest/). `pylint --recursive=y --rcfile=.pylintrc .`. All warnings but `fixme` must be addressed. +Note: When running code through `pylint`, it may be beneficial to compare the output from the base branch to the development branch by using a [diff checker](http://diffchecker.com/). To copy the output of `pylint` on Linux, you can use `pylint --recursive=y --rcfile=.pylintrc . | xsel -ib` + # Before Merging - \[ \] `Squash & Merge`