kurzgesagt-in-a-nutshell / birdbot

A multipurpose bot for the kurzgesagt discord server
GNU General Public License v3.0
20 stars 4 forks source link

add pre-commit functionality check #190

Closed arcinfini closed 7 months ago

arcinfini commented 7 months ago

Add pre-commit tooling

Description

This change adds the use of the pre-commit tool. This helps the local workflow to make checks before commiting.

Purpose

It should overall lessen the number of commits made with comments "black formatting" and whatnot as it will check for our standards before allowing a commit. It's basically a local git workflow before you make commits since we all forget about black and pyright.

Checklist

Additional Context

If this were to be included, devs would need to install the pre-commit package and run pre-commit install within their local repo. After that the tool is added into the .git features and functional.

Reviewer Notes