kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7761 from Nordix/esotsal/update-coding-conventions-links 

coding-conventions: update links
This commit is contained in:
Kubernetes Prow Robot 2024-04-04 11:41:31 -07:00 committed by GitHub
parent 4c228073dc 7b08e42e52
commit ea2008d5a4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
contributors/guide/coding-conventions.md
View File

@ -14,11 +14,11 @@ description: |
- Ensure that build, release, test, and cluster-management scripts run on macOS
- Go
- [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
- [Go Code Review Comments](https://go.dev/wiki/CodeReviewComments)
- [Effective Go](https://golang.org/doc/effective_go.html)
- Know and avoid [Go landmines](https://gist.github.com/lavalamp/4bd23295a9f32706a48f)
- Comment your code.
- [Go's commenting conventions](http://blog.golang.org/godoc-documenting-go-code)
- [Go's commenting conventions](https://go.dev/doc/comment)
- If reviewers ask questions about why the code is the way it is, that's a sign that comments might be helpful.
- Command-line flags should use dashes, not underscores
- Naming
@ -36,11 +36,11 @@ description: |
## Testing conventions
- All new packages and most new significant functionality must come with unit tests.
- Table-driven tests are preferred for testing multiple scenarios/inputs. For an example, see [TestNamespaceAuthorization](https://git.k8s.io/kubernetes/test/integration/auth/auth_test.go).
- Table-driven tests are preferred for testing multiple scenarios/inputs. For an example, see [TestNamespaceAuthorization](https://github.com/kubernetes/kubernetes/blob/4b8e819355d791d96b7e9d9efe4cbafae2311c88/test/integration/auth/auth_test.go#L1201).
- Significant features should come with integration (test/integration) and/or [end-to-end (test/e2e) tests](/contributors/devel/sig-testing/e2e-tests.md).
- Including new `kubectl` commands and major features of existing commands.
- Unit tests must pass on macOS and Windows platforms - if you use Linux specific features, your test case must either be skipped on windows or compiled out (skipped is better when running Linux specific commands, compiled out is required when your code does not compile on Windows).
- Avoid relying on Docker Hub. Use the [Google Cloud Container Registry](https://gcr.io) instead.
- Avoid relying on Docker Hub. Use the [Google Cloud Artifact Registry](https://cloud.google.com/artifact-registry/) instead.
- Do not expect an asynchronous thing to happen immediately---do not wait for one second and expect a pod to be running. Wait and retry instead.
- See the [testing guide](/contributors/devel/sig-testing/testing.md) for additional testing advice.
@ -55,7 +55,7 @@ description: |
- Document directories and filenames should use dashes rather than underscores.
- Examples should also illustrate [best practices for configuration and using the system](https://kubernetes.io/docs/concepts/configuration/overview/).
- Follow these conventions for third-party code:
- Go code for normal third-party dependencies is managed using [go modules](https://github.com/golang/go/wiki/Modules) and is described in the kubernetes [vendoring guide](/contributors/devel/sig-architecture/vendor.md).
- Go code for normal third-party dependencies is managed using [go modules](https://go.dev/wiki/Modules) and is described in the kubernetes [vendoring guide](/contributors/devel/sig-architecture/vendor.md).
- Other third-party code belongs in `third_party`.
- forked third party Go code goes in `third_party/forked`.
- forked _golang stdlib_ code goes in `third_party/forked/golang`.