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

Configs for linting #190

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

Configs for linting #190

wants to merge 2 commits into from

Conversation

brunopjacob
Copy link
Collaborator

@brunopjacob brunopjacob commented Jul 23, 2024

This PR introduces linting standards for Neuromancer.

How to use:

Setup

pip install '.[dev]'
pre-commit install

then to run pre-commit with the hooks on a single file:

pre-commit run --files path/to/your/example.py

or, on all files:

pre-commit run --all-files

This will obviously change most of the files in the repository, so we can definitely expect a one-time big change in everything.

@RBirmiwal
Copy link
Collaborator

Very nice. Is there a way we can test this without going live on master, yet?

@brunopjacob
Copy link
Collaborator Author

Very nice. Is there a way we can test this without going live on master, yet?

We can test it locally and build the wheel, after doing a pre-commit run all-files and resolving the thousands of suggestions and issues that will pop up from flake8.

Depending on the outputs of flake8, we can relax some of the conditions. There will be several warnings that can be ignored, if we choose to do so. A reference list of errors and warnings here

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.

2 participants