You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+14-1
Original file line number
Diff line number
Diff line change
@@ -38,6 +38,19 @@ Here's what a typical "day in the life" of a Zarf developer might look like. Kee
38
38
39
39
This section dives deeper into how we test Zarf
40
40
41
+
### Pre-Commit Hooks and Linting
42
+
43
+
In this repo we use [pre-commit](https://pre-commit.com/) hooks for automated validation and linting. The CI pipeline will validate that all of the hooks pass so we strongly recommend that you install the hooks locally or you'll be spending a lot of time manually fixing issues that could be fixed automatically very quickly.
1. Run `pre-commit install` in the repo to install the pre-commit hooks. This will make the hooks run automatically each time you `git commit`. If you want to skip the hooks for any reason you can run `git commit --no-verify` to skip them.
51
+
52
+
> **HINT:***Consider [automatically enabling the hooks in every Git repository](https://pre-commit.com/#automatically-enabling-pre-commit-on-repositories)*
53
+
41
54
### End2End Testing
42
55
43
56
Our E2E tests utilize [Terratest](https://terratest.gruntwork.io/). They create real infrastructure in AWS that the tests get run on. By doing this we are able to make the test environments ephemeral and allow them to be run in parallel so that we can do more testing more quickly.
@@ -50,4 +63,4 @@ We're still working on building out the test suite. If you want to help check ou
0 commit comments