@@ -14,18 +14,21 @@ Please note that this project is released with a [Contributor Code of Conduct](C
1414
1515These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.
1616
17- 1 . install Go [ through download] ( https://go.dev/doc/install ) | [ through Homebrew] ( https://formulae.brew.sh/formula/go )
18- 1 . [ install golangci-lint v2] ( https://golangci-lint.run/welcome/install/#local-installation )
17+ 1 . Install Go [ through download] ( https://go.dev/doc/install ) | [ through Homebrew] ( https://formulae.brew.sh/formula/go )
18+ 2 . [ Install golangci-lint v2] ( https://golangci-lint.run/welcome/install/#local-installation )
1919
2020## Submitting a pull request
2121
22221 . [ Fork] [ fork ] and clone the repository
23- 1 . Make sure the tests pass on your machine: ` go test -v ./... `
24- 1 . Make sure linter passes on your machine: ` golangci-lint run `
25- 1 . Create a new branch: ` git checkout -b my-branch-name `
26- 1 . Make your change, add tests, and make sure the tests and linter still pass
27- 1 . Push to your fork and [ submit a pull request] [ pr ] targeting the ` main ` branch
28- 1 . Pat yourself on the back and wait for your pull request to be reviewed and merged.
23+ 2 . Make sure the tests pass on your machine: ` go test -v ./... `
24+ 3 . Make sure linter passes on your machine: ` golangci-lint run `
25+ 4 . Create a new branch: ` git checkout -b my-branch-name `
26+ 5 . Add your changes and tests, and make sure the Action workflows still pass
27+ - Run linter: ` script/lint `
28+ - Update snapshots and run tests: ` UPDATE_TOOLSNAPS=true go test ./... `
29+ - Update readme documentation: ` script/generate-docs `
30+ 6 . Push to your fork and [ submit a pull request] [ pr ] targeting the ` main ` branch
31+ 7 . Pat yourself on the back and wait for your pull request to be reviewed and merged.
2932
3033Here are a few things you can do that will increase the likelihood of your pull request being accepted:
3134
0 commit comments