Skip to content

feat: improving DevEx using pre-commit hooks and workflows #30

@HicaroD

Description

@HicaroD

Hello, guys. First and foremost, I love this project!

I would like to make a few suggestions about pre-commit hooks and workflows.

In order to ensure code quality during development, I would like to share with you some ideas related git hooks and send a PR for it.

Here is the list of suggestions / ideas that I have:

  • Ensure everything is properly formatted by using the official ruff integration for pre-commit.
  • Ensure linters are happy by also using the official ruff integration for pre-commit.
  • Ensure project is properly typed by using the official mypy integration for pre-commit.
  • Ensure all tests are passing before committing - otherwise, don't go further.
  • Adding pre-commit as developer dependency for using all the hooks.
  • Update documention to help developers to install and use pre-commit.
  • Adding new command task ci in order to run pre-commit hooks for all files and using this new command in the place of task lint for the code quality gate workflow. This way we could ensure all the code quality checks in the CI as well.

Also, with the help of Mypy, I found some typing errors that I will address in order to make sure everything passes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions