You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+11-11
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ Check out the Kubebuilder [book](https://book.kubebuilder.io).
71
71
72
72
Building Kubernetes tools and APIs involves making a lot of decisions and writing a lot of boilerplate.
73
73
74
-
In order to facilitate easily building Kubernetes APIs and tools using the canonical approach, this framework
74
+
To facilitate easily building Kubernetes APIs and tools using the canonical approach, this framework
75
75
provides a collection of Kubernetes development tools to minimize toil.
76
76
77
77
Kubebuilder attempts to facilitate the following developer workflow for building APIs
@@ -85,25 +85,25 @@ Kubebuilder attempts to facilitate the following developer workflow for building
85
85
86
86
## Scope
87
87
88
-
Building APIs using CRDs, Controllers and Admission Webhooks.
88
+
Building APIs using CRDs, Controllers, and Admission Webhooks.
89
89
90
90
## Philosophy
91
91
92
92
See [DESIGN.md](DESIGN.md) for the guiding principles of the various Kubebuilder projects.
93
93
94
94
TL;DR:
95
95
96
-
Provide clean library abstractions with clear and wellexampled godocs.
96
+
Provide clean library abstractions with clear and well-exampled go docs.
97
97
98
-
- Prefer using go *interfaces* and *libraries* overrelying on *code generation*
98
+
- Prefer using go *interfaces* and *libraries* over-relying on *code generation*
99
99
- Prefer using *code generation* over *1 time init* of stubs
100
100
- Prefer *1 time init* of stubs over forked and modified boilerplate
101
101
- Never fork and modify boilerplate
102
102
103
103
## Techniques
104
104
105
-
- Provide higherlevel libraries on top of lowlevel client libraries
106
-
- Protect developers from breaking changes in lowlevel libraries
105
+
- Provide higher-level libraries on top of low-level client libraries
106
+
- Protect developers from breaking changes in low-level libraries
107
107
- Start minimal and provide progressive discovery of functionality
108
108
- Provide sane defaults and allow users to override when they exist
109
109
- Provide code generators to maintain common boilerplate that can't be addressed by interfaces
@@ -121,13 +121,13 @@ See [VERSIONING.md](VERSIONING.md).
121
121
Before you file an issue, please search existing issues to see if your issue is already covered.
122
122
123
123
-### Slack
124
-
For realtime discussion, you can join the [#kubebuilder](https://slack.k8s.io/#kubebuilder) slack channel. Slack requires registration, but the Kubernetes team is open invitation to anyone to register here. Feel free to come and ask any questions.
124
+
For real-time discussion, you can join the [#kubebuilder](https://slack.k8s.io/#kubebuilder) slack channel. Slack requires registration, but the Kubernetes team is an open invitation to anyone to register here. Feel free to come and ask any questions.
125
125
126
126
## Contributing
127
127
128
-
Contributions are greatly appreciated. The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers.
128
+
Contributions are greatly appreciated. The maintainers actively manage the issues list and try to highlight issues suitable for newcomers.
129
129
The project follows the typical GitHub pull request model. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
130
-
Before starting any work, please either comment on an existing issue, or file a new one.
130
+
Before starting any work, please either comment on an existing issue or file a new one.
131
131
132
132
## Operating Systems Supported
133
133
@@ -146,7 +146,7 @@ Additionally, these projects include a `go.mod` file specifying dependency versi
146
146
Kubebuilder relies on [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime) and its Go and Kubernetes dependencies.
147
147
Therefore, the versions defined in the `Makefile` and `go.mod` files are the ones that have been tested, supported, and recommended.
148
148
149
-
Each minor version of Kubebuilder is tested with a specific minor version of client-go.
149
+
Each minor version of Kubebuilder is tested with a specific minor version of the client-go.
150
150
While a Kubebuilder minor version *may* be compatible with other client-go minor versions,
151
151
or other tools this compatibility is not guaranteed, supported, or tested.
152
152
@@ -159,7 +159,7 @@ file scaffolded for each project for each [tag release](https://github.com/kuber
159
159
160
160
**Example:** For the `4.1.1` release, the minimum Go version compatibility is `1.22`.
161
161
You can refer to the samples in the testdata directory of the tag released [v4.1.1](https://github.com/kubernetes-sigs/kubebuilder/tree/v4.1.1/testdata),
162
-
such as the [go.mod](https://github.com/kubernetes-sigs/kubebuilder/blob/v4.1.1/testdata/project-v4/go.mod#L3) file for `project-v4`. You can also check the tools versions supported and
162
+
such as the [go.mod](https://github.com/kubernetes-sigs/kubebuilder/blob/v4.1.1/testdata/project-v4/go.mod#L3) file for `project-v4`. You can also check the versions of the tools supported and
163
163
tested for this release by examining the [Makefile](https://github.com/kubernetes-sigs/kubebuilder/blob/v4.1.1/testdata/project-v4/Makefile#L160-L165).
0 commit comments