Skip to content

Commit 055e59f

Browse files
committed
docs: add helper commands section to CONTRIBUTING.md
Signed-off-by: Justin Chadwell <[email protected]>
1 parent 61687a5 commit 055e59f

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

.github/CONTRIBUTING.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,20 +99,25 @@ If you are working behind a proxy, you can set some of or all
9999
`HTTP_PROXY=http://ip:port`, `HTTPS_PROXY=http://ip:port`, `NO_PROXY=http://ip:port` for the test framework
100100
to specify the proxy build args.
101101

102-
Updating vendored dependencies:
102+
### Run the helper commands
103+
104+
To validate PRs before submitting them you should run:
103105

104106
```bash
105-
# update vendor.conf
106-
make vendor
107+
$ make validate-all
107108
```
108109

109-
Validating your updates before submission:
110+
To generate new vendored files with go modules run:
110111

111112
```bash
112-
make validate-all
113+
$ make vendor
113114
```
114115

116+
To generate new versions of automatically generated files run:
115117

118+
```bash
119+
$ make generated-files
120+
```
116121

117122
### Pull requests are always welcome
118123

0 commit comments

Comments
 (0)