pronovic / apologies Goto Github PK

You might consider adding coveralls and then showing a badge with the coverage percentage in the README file.

On a side note, this project is a great learning tool and some people checking it out will not be very familiar with github. You might add a section to the README (or CONTRIBUTING DEVELOPER guide) that talks about how the "behind the scenes" stuff gets setup on github. As an example, if you add coveralls, then you'll need to add a secret, so you could provide a very short guide indicating that you need to add "this secret" to "here", then it becomes available in the github actions workflow as an environment variable, etc. Any other web hooks or anything else in the "settings" page that another user cannot see is a good thing to document for newer users in a learning repository like this. Maybe indicating how the documents get from here to readthedocs would be another good example.

Hey, thanks for this repo, really helped me out setting up poetry+precommit on my project.

However I'd like to suggest altering the black and isort configs in .pre-commit-config.yaml to be as follows:

repos:
  - repo: local
    hooks:
      - id: system
        name: Black
        entry: poetry run black
        types: [python]
        language: system
  - repo: local
    hooks:
      - id: system
        name: isort
        entry: poetry run isort
        types: [python]
        language: system

this way these checks only run on files staged for commit, which saves a lot of headaches during code refactoring

and if you'd like to run pre-commit on your entire project, you can run pre-commit run --all-files