@@ -18,7 +18,6 @@ We also like to send gifts—if you're into schwag, make sure to let
18
18
us know. We currently do not offer a paid security bounty program, but are not
19
19
ruling it out in the future.
20
20
21
-
22
21
## Reporting other issues
23
22
24
23
A great way to contribute to the project is to send a detailed report when you
@@ -52,7 +51,6 @@ Dependencies:
52
51
- [ runc] ( https://github.com/opencontainers/runc )
53
52
- [ containerd] ( https://github.com/containerd/containerd ) (if you want to use containerd worker)
54
53
55
-
56
54
The following command installs ` buildkitd ` and ` buildctl ` to ` /usr/local/bin ` :
57
55
58
56
``` bash
@@ -330,13 +328,11 @@ down to one.
330
328
from the Git history.
331
329
- See the [ Coding Style] ( #coding-style ) for further guidelines.
332
330
333
-
334
331
### Merge approval
335
332
336
333
Project maintainers use LGTM (Looks Good To Me) in comments on the code review to
337
334
indicate acceptance, or use the Github review approval feature.
338
335
339
-
340
336
## Coding Style
341
337
342
338
Unless explicitly stated, we follow all coding guidelines from the Go
@@ -353,29 +349,29 @@ mind when nudging others to comply.
353
349
354
350
The rules:
355
351
356
- 1 . All code should be formatted with ` gofmt -s ` .
357
- 2 . All code should pass the default levels of
358
- [ ` golint ` ] ( https://github.com/golang/lint ) .
359
- 3 . All code should follow the guidelines covered in [ Effective
360
- Go] ( http://golang.org/doc/effective_go.html ) and [ Go Code Review
361
- Comments] ( https://github.com/golang/go/wiki/CodeReviewComments ) .
362
- 4 . Comment the code. Tell us the why, the history and the context.
363
- 5 . Document _ all_ declarations and methods, even private ones. Declare
364
- expectations, caveats and anything else that may be important. If a type
365
- gets exported, having the comments already there will ensure it's ready.
366
- 6 . Variable name length should be proportional to its context and no longer.
367
- ` noCommaALongVariableNameLikeThisIsNotMoreClearWhenASimpleCommentWouldDo ` .
368
- In practice, short methods will have short variable names and globals will
369
- have longer names.
370
- 7 . No underscores in package names. If you need a compound name, step back,
371
- and re-examine why you need a compound name. If you still think you need a
372
- compound name, lose the underscore.
373
- 8 . No utils or helpers packages. If a function is not general enough to
374
- warrant its own package, it has not been written generally enough to be a
375
- part of a util package. Just leave it unexported and well-documented.
376
- 9 . All tests should run with ` go test ` and outside tooling should not be
377
- required. No, we don't need another unit testing framework. Assertion
378
- packages are acceptable if they provide _ real_ incremental value.
352
+ 1 . All code should be formatted with ` gofmt -s ` .
353
+ 2 . All code should pass the default levels of
354
+ [ ` golint ` ] ( https://github.com/golang/lint ) .
355
+ 3 . All code should follow the guidelines covered in [ Effective
356
+ Go] ( http://golang.org/doc/effective_go.html ) and [ Go Code Review
357
+ Comments] ( https://github.com/golang/go/wiki/CodeReviewComments ) .
358
+ 4 . Comment the code. Tell us the why, the history and the context.
359
+ 5 . Document _ all_ declarations and methods, even private ones. Declare
360
+ expectations, caveats and anything else that may be important. If a type
361
+ gets exported, having the comments already there will ensure it's ready.
362
+ 6 . Variable name length should be proportional to its context and no longer.
363
+ ` noCommaALongVariableNameLikeThisIsNotMoreClearWhenASimpleCommentWouldDo ` .
364
+ In practice, short methods will have short variable names and globals will
365
+ have longer names.
366
+ 7 . No underscores in package names. If you need a compound name, step back,
367
+ and re-examine why you need a compound name. If you still think you need a
368
+ compound name, lose the underscore.
369
+ 8 . No utils or helpers packages. If a function is not general enough to
370
+ warrant its own package, it has not been written generally enough to be a
371
+ part of a util package. Just leave it unexported and well-documented.
372
+ 9 . All tests should run with ` go test ` and outside tooling should not be
373
+ required. No, we don't need another unit testing framework. Assertion
374
+ packages are acceptable if they provide _ real_ incremental value.
379
375
10 . Even though we call these "rules" above, they are actually just
380
376
guidelines. Since you've read all the rules, you now know that.
381
377
0 commit comments