Skip to content
This repository has been archived by the owner on Sep 29, 2021. It is now read-only.

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:

  1. Install git, and have the Humane Transport Repo as described here.
  2. Using the instructions here install pre-commit on your device. Note: Homebrew can do this for Mac users.
  3. 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)

Client meeting minutes pages:

  1. Progress Update and Project Requirement Questions Oct 5, 2020
  2. Progress Update Meeting Oct 29, 2020
  3. Progress Update Meeting and USM-related questions Nov 11, 2020
  4. Mentor Progress Update Meeting Nov 25, 2020
  5. Livestock Services Saskatchewan Project Meeting Dec 3, 2020
  6. Team and Instructor, Mentor, and Faculty Meeting Minutes

Team meeting minutes pages:

  1. Sprint 0
  2. Sprint 1
  3. Sprint 1 Retrospective
  4. Sprint 2
  5. Sprint 2 Retrospective
  6. Sprint 3
  7. Sprint 3 Retrospective
  8. Sprint 4
  9. Sprint 4 Retrospective
  10. Sprint 5
  11. Sprint 5 Retrospective
  12. Sprint 6
  13. Sprint 6 Retrospective
  14. Sprint 7
  15. Sprint 8
  16. Sprint 7/8 Retrospective
  17. Sprint 9
  18. Sprint 10

Requirements-related pages:

  1. About Project Charter
  2. About Project Requirements

Specification-related pages:

  1. Animal Record Transport Template Breakdown
  2. Transfer of Care Document Breakdown
  3. FWR Document Breakdown
  4. Contingency Plan Breakdown

User Story Mapping-related pages:

  1. User Story Mapping Guide

Design-related pages:

  1. C4-Model for Client-Server Architecture
  2. Data Modelling Design Process
  3. Guide to GUI Prototyping Structure

System Test Procedure pages:

  1. Animal Transport Record-related Test Cases
  2. Transporter Account-related Test Cases
  3. System Settings-related Test Cases

Investigation pages:

  1. Adobe XD vs Figma
  2. Client-Server Architecture Tools
  3. Firebase vs. AWS Amplify

Project Setup/FAQ pages:

  1. Cloning Humane Transport
  2. Set up Pre-Commit
  3. IDE Useful Settings
  4. Testing Workflow
  5. Useful Git Commands
  6. Must Know Flutter Concepts
Clone this wiki locally