Northeastern-Electric-Racing / Northeastern-Electric-Racing/FinishLine
Use Husky Pre-commit Hooks
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 36
- Forks
- 9
- Avg merge
- 4d 21h
- Merged PRs (30d)
- 11
Description
Spike Type
Technical
Goal
This spike ticket is to look into using Husky pre-commit hooks in FinishLine that makes sure all tests are passing, prettier is validated / run, and eslint is linted / passing before committing.
Reason for Spike
This spike will help prevent unnecessary commits and pushes to the codebase that involve failing code (tests), non-formatted code, and un-linted code.
Additional notes
Look into https://typicode.github.io/husky/how-to.html for some how to code.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Husky how-to documentation linked in the issue, then inspect FinishLine's existing test, Prettier, and ESLint commands. Determine how pre-commit hooks could validate these checks and document the resulting setup and behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100