Skip to content

Commit

Permalink
Merge pull request #5 from aconstas/main
Browse files Browse the repository at this point in the history
add documentation on bypassing pre-commit hook
  • Loading branch information
aconstas authored May 26, 2024
2 parents 5eea247 + 97bd824 commit e95007b
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- [**Working with pull requests and reviews**](#working-with-pull-requests-and-reviews)
- [**Testing**](#testing)
- [**Automated Accessibility Testing**](#automated-accessibility-testing)
- [**Bypassing Pre-Commit Hooks**](#bypassing-pre-commit-hooks)
- [**Resources**](#resources)


Expand Down Expand Up @@ -168,10 +169,16 @@ To view the Pa11y test results, you can easily open the CSV file within your IDE
- Click `Open With`.
- Select `CSV Editor`.

Following these steps will allow you to easily view and analyze the Pa11y test results.
### Bypassing Pre-Commit Hooks

We use [Husky](https://typicode.github.io/husky/) to enforce a pre-commit hook that runs the Pa11y accessibility test. In certain situations, you might want to bypass these hooks (like when working on something not directly related to the pages of the microsite). You can do this by:
- #### Using ` HUSKY=0 `
Example: `HUSKY=0 git commit -m 'message'`
- #### Using ` -n ` after your Git command
Example: `git commit -m 'message' -n`
## Resources
- [Hack for LA's Internship Wiki]()
- [Snippets](SNIPPETS.md)
- [Excel Viewer by GrapeCity](https://marketplace.visualstudio.com/items?itemName=GrapeCity.gc-excelviewer)
- [Husky](https://typicode.github.io/husky/)

0 comments on commit e95007b

Please sign in to comment.