ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-05-30 23:29:30 +03:00
Code Issues Projects Releases Wiki Activity

Contributing/Python-env: Note VSCode issue with pre-commit.

Browse Source
This commit is contained in:
Athanasius 2022-12-21 13:10:01 +00:00
parent 254988fd80
commit 2b79b89803
No known key found for this signature in database
GPG Key ID: 772697E181BB2767
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Contributing.md
View File

@ -245,6 +245,10 @@ code is compliant with our requirements. If you have a *temporary* need to
bypass this (e.g. wanting to commit one change and fix a non-compliant file bypass this (e.g. wanting to commit one change and fix a non-compliant file
later) you can add `-n` to the `git commit` arguments. later) you can add `-n` to the `git commit` arguments.
**NB: There is [a problem](https://github.com/microsoft/vscode-python/issues/10165)
with pre-commit if using VSCode.** There's a workaround in
[one of the comments](https://github.com/microsoft/vscode-python/issues/10165#issuecomment-1277237676).
### Consider running `pytest` before any `git push` ### Consider running `pytest` before any `git push`
The GitHub workflows for PRs and pushes will run `pytest` and flag an error The GitHub workflows for PRs and pushes will run `pytest` and flag an error
if the tests don't pass, so it's in your interests to ensure you've not broken if the tests don't pass, so it's in your interests to ensure you've not broken