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

Merge branch Davi0kProgramsThings:fix/refactoring into branch bitfinexcom:master. #235

Merged
merged 14 commits into from
Mar 5, 2024

Conversation

Davi0kProgramsThings
Copy link
Contributor

Description

PR introduces isort, black and flake8 in the project's development stack.
It also introduces support for pre-commit (see .pre-commit-config.yaml).
New steps has been added to the build action in bitfinex-api-py-ci.yml.

README has been updated with a brief chapter on how to set up pre-commit.

The project won't support pylint anymore.

Motivation and Context

From now on, developers will no longer need to write code that complies to PEP8 theirself.
pre-commit will take care of formatting the project's code base to fit the PEP8 style guidelines.
The developers will only be responsible for ensuring that flake8 does not return any error.

Related Issue

PR fixes the following issue: -

Type of change

  • Bug fix (non-breaking change which fixes an issue);
  • New feature (non-breaking change which adds functionality);
  • Breaking change (fix or feature that would cause existing functionality to not work as expected);
  • This change requires a documentation update;

Checklist:

  • I've done a self-review of my code;
  • I've made corresponding changes to the documentation;
  • I've made sure my changes generate no warnings;
  • mypy returns no errors when run on the root package;
  • I've run black to format my code;
  • I've run isort to format my code's import statements;
  • flake8 reports no errors when run on the entire code base;

@itsdeka itsdeka merged commit 3136b9c into bitfinexcom:master Mar 5, 2024
1 check passed
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