This repository has been archived by the owner on Sep 29, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Setup Pre Commit
Kelly Holtzman edited this page Jan 12, 2021
·
3 revisions
WARNING: Cannot do this on Windows because it lacks symlinks and support
Some very useful plugins, git hooks, settings, etc. are described here.
A short and sweet version of set up is as follows:
- Install git, and have the Humane Transport Repo as described here.
- Using the instructions here install pre-commit on your device. Note: Homebrew can do this for Mac users.
- Now, with the combination of git and pre-commit, we can use the formatting instructions as outlined in our
.pre-commit-config.yaml
file.
The formatter(s) will run when committing changes using your command-line tool of choice. I think that using a GUI-based tool, like GitHub Desktop, will not run the formatters so be aware.
Additionally, we will have (or eventually will have) GitHub Actions set up to do this work on every branch/PR/etc. and you can either solely rely on those (not recommended) or use them in conjunction with pre-commit (recommended).
Deliverables pages (see website)
- Progress Update and Project Requirement Questions Oct 5, 2020
- Progress Update Meeting Oct 29, 2020
- Progress Update Meeting and USM-related questions Nov 11, 2020
- Mentor Progress Update Meeting Nov 25, 2020
- Livestock Services Saskatchewan Project Meeting Dec 3, 2020
- Team and Instructor, Mentor, and Faculty Meeting Minutes
- Sprint 0
- Sprint 1
- Sprint 1 Retrospective
- Sprint 2
- Sprint 2 Retrospective
- Sprint 3
- Sprint 3 Retrospective
- Sprint 4
- Sprint 4 Retrospective
- Sprint 5
- Sprint 5 Retrospective
- Sprint 6
- Sprint 6 Retrospective
- Sprint 7
- Sprint 8
- Sprint 7/8 Retrospective
- Sprint 9
- Sprint 10
- Animal Record Transport Template Breakdown
- Transfer of Care Document Breakdown
- FWR Document Breakdown
- Contingency Plan Breakdown
- C4-Model for Client-Server Architecture
- Data Modelling Design Process
- Guide to GUI Prototyping Structure