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
+11-6Lines changed: 11 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -38,11 +38,18 @@ For contributors who want to work up pull requests, the workflow is roughly:
38
38
3. Make sure your commit messages are in the proper format (see [below](#commit-message-format)).
39
39
4. Push your changes to a topic branch in your fork of the repository.
40
40
5. Make sure the tests pass, and add any new tests as appropriate.
41
-
6. Please run this command before submitting your pull request:
41
+
6. We run a number of linters and tests on each pull request.
42
+
You may wish to run these locally before submitting your pull request:
42
43
```sh
43
-
make structure-check
44
+
hack/go-fmt.sh .
45
+
hack/go-lint.sh $(go list -f '{{ .ImportPath }}' ./...)
46
+
hack/go-vet.sh ./...
47
+
hack/shellcheck.sh
48
+
hack/test-bazel-build-tarball.sh
49
+
hack/tf-fmt.sh -list -check
50
+
hack/tf-lint.sh
51
+
hack/yaml-lint.sh
44
52
```
45
-
Note that a portion of the docs and examples are generated and that the generated files are to be committed by you. `make structure-check` checks that what is generated is what you must commit.
46
53
7. Submit a pull request to the original repository.
47
54
8. The [repo](OWNERS) [owners](OWNERS_ALIASES) will respond to your issue promptly, following [the ususal Prow workflow][prow-review].
48
55
@@ -52,9 +59,7 @@ Thanks for your contributions!
52
59
53
60
The coding style suggested by the Golang community is used in installer. See the [style doc][golang-style] for details. Please follow them when working on your contributions.
54
61
55
-
Tectonic Installer includes syntax checks on the Terraform templates which will fail the PR checker for non-standard formatted code.
56
-
57
-
Use `make structure-check` to identify files that don't meet the canonical format and style. Then, use `terraform fmt` to align the template syntax, if necessary.
62
+
Terraform has similar standards, and you can run `terraform fmt` to rewrite Terraform files to the canonical format.
0 commit comments