Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install pre-commit and fix configuration and builds #130

Merged
merged 2 commits into from
Sep 10, 2021
Merged

Conversation

ziotom78
Copy link
Member

@ziotom78 ziotom78 commented Sep 10, 2021

This small PR installs pre-commit and documents its usage. This module is optional for developers, but it can save a lot of time when doing modifications to the repository. Now that issue #126 has been fixed, all the tests in bin/run_tests.sh are ran and checked properly by GitHub, and things are more likely to go bad! The script checks for proper code formatting and a number of stylistic errors (e.g., too long lines, unused variables).

The usage of pre-commit enables developers to discover these problems before running git push, as black and flake8 are ran automatically whenever the user calls git commit.

There is no need for developers to use this facility, so if you're happy with your workflow, this PR does not affect it.

@ziotom78
Copy link
Member Author

I have removed the AppVeyor config file, which was used only to check that the code was runnable under WSL but it has not been maintained since ages. We'll decide if we want to add tests for Windows using GitHub Actions, which would be far easier to handle.

@ziotom78 ziotom78 merged commit 48cfaae into master Sep 10, 2021
@ziotom78 ziotom78 changed the title Install pre-commit and fix the configuration for flake8/black Install pre-commit and fix configuration and builds Sep 10, 2021
@ziotom78 ziotom78 deleted the environmentfix branch September 10, 2021 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant