Skip to content

Feature/use pre commit#102

Open
colonesej wants to merge 4 commits into
developfrom
feature/use_pre_commit
Open

Feature/use pre commit#102
colonesej wants to merge 4 commits into
developfrom
feature/use_pre_commit

Conversation

@colonesej

Copy link
Copy Markdown
Collaborator

This pull request introduces a comprehensive quality assurance (QA) workflow to the project, including CI job updates, pre-commit hook configuration, and improved documentation for local development. The changes ensure code quality checks are consistently run both in CI and locally, and clarify installation and development processes.

QA and CI Improvements:

  • Added a .pre-commit-config.yaml file configuring isort, black, and flake8 hooks with pinned versions to ensure consistent code formatting and linting across contributors.
  • Updated the qa dependencies group in pyproject.toml to include black, flake8, isort, and pre-commit, and added a dev group for easier local setup.

Documentation Enhancements:

  • Expanded the README.md with a new section detailing the QA checks run in CI, instructions for running them locally, and rationale for their order.
  • Minor formatting improvements in the installation section of the README.md.

CI Configuration Update:

  • Updated the docs job in the GitHub Actions workflow to use ubuntu-lts-latest for improved stability and compatibility.

Build System Maintenance:

  • Updated setuptools_scm configuration in pyproject.toml to use version_file and version_file_template instead of deprecated options.

Contributor Declaration

By opening this pull request, I affirm the following:

  • All authors agree to the Contributor License Agreement.
  • The code follows the project's coding standards.
  • I have performed self-review and added comments where needed.
  • I have added or updated tests to verify that my changes are effective and functional.
  • I have run all existing tests and confirmed they pass.

@colonesej colonesej requested a review from corentincarton July 2, 2026 15:21
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