Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos in DEVELOPMENT.md file #7179

Closed
wants to merge 1 commit into from
Closed

Fix typos in DEVELOPMENT.md file #7179

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,10 @@ The Tekton project requires that you develop (commit) code changes to branches t

```shell
git remote add upstream [email protected]:tektoncd/pipeline.git
```

# Optional: Prevent accidental pushing of commits by changing the upstream URL to `no_push`
3. Optional: Prevent accidental pushing of commits by changing the upstream URL to `no_push`
```shell
Comment on lines 166 to +170
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why need this change

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for review
Prior , it is as below:
Screenshot 2023-10-05 at 11 23 52 PM

When copied and pasted in zsh shell , below error is thrown.

# Optional: Prevent accidental pushing of commits by changing the upstream URL to `no_push`
git remote set-url --push upstream no_push
zsh: command not found: no_push
zsh: command not found: #

When optional section is moved to new line as below, the issue is not seen
Screenshot 2023-10-05 at 11 26 08 PM

git remote set-url --push upstream no_push
```

Expand Down Expand Up @@ -271,9 +273,9 @@ The recommended minimum development configuration is:
- 8 GB of (actual or virtualized) platform memory
- Node autoscaling, up to 3 nodes

#### Using [KinD](https://kind.sigs.k8s.io/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remember this was because it stands for K8s in Docker, but I'm ok with either

#### Using [Kind](https://kind.sigs.k8s.io/)

[KinD](https://kind.sigs.k8s.io/) is a great tool for working with Kubernetes clusters locally. It is particularly useful to quickly test code against different cluster [configurations](https://kind.sigs.k8s.io/docs/user/quick-start/#advanced).
[Kind](https://kind.sigs.k8s.io/) is a great tool for working with Kubernetes clusters locally. It is particularly useful to quickly test code against different cluster [configurations](https://kind.sigs.k8s.io/docs/user/quick-start/#advanced).

1. Install [required tools](./DEVELOPMENT.md#install-tools) (note: may require a newer version of Go).
2. Install [Docker](https://www.docker.com/get-started).
Expand Down Expand Up @@ -353,7 +355,7 @@ While iterating on code changes to the project, you may need to:
- Update your (external) dependencies with: `./hack/update-deps.sh`
- Update your type definitions with: `./hack/update-codegen.sh`
- Update your OpenAPI specs with: `./hack/update-openapigen.sh`
1. Update or [add new CRD types](#adding-new-types) as needed
1. Update or [add new CRD types](#adding-new-crd-types) as needed
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

1. Update, [add and run tests](./test/README.md#tests)

To make changes to these CRDs, you will probably interact with:
Expand Down