Skip to content

Commit 2c88af0

Browse files
authored
Merge pull request #4603 from chethanm99/chethanm99-patch-1-update-README.md
📖 Update README.md with minor changes
2 parents 148d879 + acf5e99 commit 2c88af0

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Check out the Kubebuilder [book](https://book.kubebuilder.io).
7171

7272
Building Kubernetes tools and APIs involves making a lot of decisions and writing a lot of boilerplate.
7373

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
7575
provides a collection of Kubernetes development tools to minimize toil.
7676

7777
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
8585

8686
## Scope
8787

88-
Building APIs using CRDs, Controllers and Admission Webhooks.
88+
Building APIs using CRDs, Controllers, and Admission Webhooks.
8989

9090
## Philosophy
9191

9292
See [DESIGN.md](DESIGN.md) for the guiding principles of the various Kubebuilder projects.
9393

9494
TL;DR:
9595

96-
Provide clean library abstractions with clear and well exampled godocs.
96+
Provide clean library abstractions with clear and well-exampled go docs.
9797

98-
- Prefer using go *interfaces* and *libraries* over relying on *code generation*
98+
- Prefer using go *interfaces* and *libraries* over-relying on *code generation*
9999
- Prefer using *code generation* over *1 time init* of stubs
100100
- Prefer *1 time init* of stubs over forked and modified boilerplate
101101
- Never fork and modify boilerplate
102102

103103
## Techniques
104104

105-
- Provide higher level libraries on top of low level client libraries
106-
- Protect developers from breaking changes in low level libraries
105+
- Provide higher-level libraries on top of low-level client libraries
106+
- Protect developers from breaking changes in low-level libraries
107107
- Start minimal and provide progressive discovery of functionality
108108
- Provide sane defaults and allow users to override when they exist
109109
- Provide code generators to maintain common boilerplate that can't be addressed by interfaces
@@ -121,13 +121,13 @@ See [VERSIONING.md](VERSIONING.md).
121121
Before you file an issue, please search existing issues to see if your issue is already covered.
122122

123123
- ### 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.
125125

126126
## Contributing
127127

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.
129129
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.
131131

132132
## Operating Systems Supported
133133

@@ -146,7 +146,7 @@ Additionally, these projects include a `go.mod` file specifying dependency versi
146146
Kubebuilder relies on [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime) and its Go and Kubernetes dependencies.
147147
Therefore, the versions defined in the `Makefile` and `go.mod` files are the ones that have been tested, supported, and recommended.
148148

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.
150150
While a Kubebuilder minor version *may* be compatible with other client-go minor versions,
151151
or other tools this compatibility is not guaranteed, supported, or tested.
152152

@@ -159,7 +159,7 @@ file scaffolded for each project for each [tag release](https://github.com/kuber
159159

160160
**Example:** For the `4.1.1` release, the minimum Go version compatibility is `1.22`.
161161
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
163163
tested for this release by examining the [Makefile](https://github.com/kubernetes-sigs/kubebuilder/blob/v4.1.1/testdata/project-v4/Makefile#L160-L165).
164164

165165
## Community Meetings

0 commit comments

Comments
 (0)