-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
93bbca3
commit 13c9ed3
Showing
8 changed files
with
20 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,4 +13,4 @@ jobs: | |
with: | ||
go-version: 1.x | ||
cache-dependency-path: "**/go.sum" | ||
- run: scripts/lint.sh | ||
- run: script/lint.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
*.sh | ||
!/scripts/*.sh | ||
!/script/*.sh | ||
*.test | ||
coverage.out | ||
/bin | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -51,9 +51,9 @@ are more sensitive, emailed to <[email protected]>. | |
either add tests to cover those lines or add a PR comment explaining the | ||
untested lines. | ||
|
||
4. Run `scripts/fmt.sh`, `scripts/test.sh` and `scripts/lint.sh` to format your code and | ||
check that it passes all tests and linters. `scripts/lint.sh` may also tell you | ||
that generated files need to be updated. If so, run `scripts/generate.sh` to | ||
4. Run `script/fmt.sh`, `script/test.sh` and `script/lint.sh` to format your code and | ||
check that it passes all tests and linters. `script/lint.sh` may also tell you | ||
that generated files need to be updated. If so, run `script/generate.sh` to | ||
update them. | ||
|
||
5. Do your best to have [well-formed commit messages][] for each change. This | ||
|
@@ -75,18 +75,18 @@ are more sensitive, emailed to <[email protected]>. | |
|
||
## Scripts ## | ||
|
||
The `scripts` directory has shell scripts that help with common development | ||
The `script` directory has shell scripts that help with common development | ||
tasks. | ||
|
||
**scripts/fmt.sh** formats all go code in the repository. | ||
**script/fmt.sh** formats all go code in the repository. | ||
|
||
**scripts/generate.sh** runs code generators and `go mod tidy` on all modules. With | ||
**script/generate.sh** runs code generators and `go mod tidy` on all modules. With | ||
`--check` it checks that the generated files are current. | ||
|
||
**scripts/lint.sh** runs linters on the project and checks generated files are | ||
**script/lint.sh** runs linters on the project and checks generated files are | ||
current. | ||
|
||
**scripts/test.sh** runs tests on all modules. | ||
**script/test.sh** runs tests on all modules. | ||
|
||
## Other notes on code organization ## | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters