Skip to content

Conversation

@ax3l
Copy link
Collaborator

@ax3l ax3l commented Sep 26, 2023

Add basis for automated pre-commit checks.
Install locally via:

python3 -m pip install -U pre-commit
pre-commit install

See: https://pre-commit.com

We will use this to automatically fix style issues in PRs via https://pre-commit.ci

To Do

Locally, run

pre-commit run -a
  • update styles
  • update docs (blacken-docs)
  • update API doc strings (pydocstyle)

@ax3l ax3l requested a review from AngelFP September 26, 2023 17:34
Add basis for automated pre-commit checks.
Install locally via:

```bash
python3 -m pip install -U pre-commit
pre-commit install
```

See: https://pre-commit.com

We will use this to automatically fix style issues in PRs via https://pre-commit.ci
@ax3l ax3l added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Sep 26, 2023
@AngelFP AngelFP changed the title Install pre-commit [WIP] Install pre-commit Sep 27, 2023
Copy link
Member

@AngelFP AngelFP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Phew! That was quite an effort, but everything is now nicely compliant with the CI checks.

Thanks a lot for setting this up @ax3l !

@AngelFP AngelFP changed the title [WIP] Install pre-commit Install pre-commit Oct 10, 2023
@AngelFP AngelFP merged commit afda164 into optimas-org:main Oct 10, 2023
@ax3l ax3l deleted the pre-commit-setup branch October 13, 2023 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants