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

docs: updated the developer guide #5347

Merged
merged 3 commits into from
Feb 25, 2025
Merged

docs: updated the developer guide #5347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ffa4cf
docs: updated the developer guide
Anu-Ra-g Feb 25, 2025
97bda5a
made some updates
Anu-Ra-g Feb 25, 2025
002174f
updated the comments for PR template
Anu-Ra-g Feb 25, 2025
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
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Examples:
* "fix: fix xx bug"
* "chore: change ci & build tools etc"
* "api: add xxx fields in ClientTrafficPolicy"
Before raising a PR, please go through this section of the developer guide, https://gateway.envoyproxy.io/contributions/develop/#raising-a-pr
-->

<!--
Expand Down
11 changes: 9 additions & 2 deletions site/content/en/contributions/DEVELOP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Envoy Gateway is built using a [make][]-based build system. Our CI is based on [

### go

* Version: 1.22
* Version: 1.24
* Installation Guide: https://go.dev/doc/install

### make
Expand All @@ -34,7 +34,7 @@ Envoy Gateway is built using a [make][]-based build system. Our CI is based on [

## Quickstart

* Run `make help` to see all the available targets to build, test and run Envoy Gateway.
Run `make help` to see all the available targets to build, test and run Envoy Gateway. Below are the other make directives

### Building

Expand All @@ -48,11 +48,14 @@ __Note:__ The binaries get generated in the `bin/$OS/$ARCH` directory, for examp

* Run `make test` to run the golang tests.

* Run `make e2e` to perform end-to-end testing.

* Run `make testdata` to generate the golden YAML testdata files.

### Running Linters

* Run `make lint` to make sure your code passes all the linter checks.

__Note:__ The `golangci-lint` configuration resides [here](https://github.com/envoyproxy/gateway/blob/main/tools/linter/golangci-lint/.golangci.yml).

### Building and Pushing the Image
Expand All @@ -62,6 +65,10 @@ __Note:__ The `golangci-lint` configuration resides [here](https://github.com/en

__Note:__ Replace `IMAGE` with your registry's image name.

### Raising a PR

* Run `make generate` and push the generated files along with your commit, if your PR contains any **API** changes (changes in `/api` folder), you've added some unit tests or you've updated the modules used in the project.

Copy link
Contributor

Choose a reason for hiding this comment

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

can we also add a line here on make testdata - which generates output testdata

Copy link
Contributor Author

@Anu-Ra-g Anu-Ra-g Feb 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

It's already present in the testing section. Should I add it here also?
image

Copy link
Contributor

Choose a reason for hiding this comment

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

cool thanks

### Deploying Envoy Gateway for Test/Dev

* Run `make create-cluster` to create a [Kind][] cluster.
Expand Down