Skip to content

docs: add pointer to contributing guide in README #11126

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

Jump to bottom
Merged
merged 1 commit into from
May 1, 2025
Merged

docs: add pointer to contributing guide in README #11126

merged 1 commit into from
May 1, 2025

Conversation

rodrigc
Copy link
Contributor

@rodrigc rodrigc commented Apr 25, 2025

Signed-off-by: Craig Rodrigues [email protected]

Duplicate the content in the CONTRIBUTING.md file in README.md, to make it easier to find when browing the code at

https://github.com/kgateway-dev/kgateway/?tab=readme-ov-file#--------------------an-envoy-powered-kubernetes-native-api-gateway

Docs changes

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

@nfuden nfuden enabled auto-merge April 25, 2025 18:58
auto-merge was automatically disabled April 25, 2025 21:01

Head branch was pushed to by a user without write access

@rodrigc rodrigc force-pushed the update-contributing branch from 616a418 to 3a393a4 Compare April 25, 2025 21:01
@timflannagan timflannagan enabled auto-merge April 25, 2025 21:07
@rodrigc rodrigc mentioned this pull request Apr 28, 2025
Closed
auto-merge was automatically disabled May 1, 2025 16:31

Head branch was pushed to by a user without write access

@rodrigc rodrigc force-pushed the update-contributing branch from 3a393a4 to 65d7141 Compare May 1, 2025 16:31
@timflannagan timflannagan enabled auto-merge May 1, 2025 16:32
@timflannagan timflannagan added this pull request to the merge queue May 1, 2025
Merged via the queue into kgateway-dev:main with commit 0917ffc May 1, 2025
16 checks passed
MayorFaj pushed a commit to MayorFaj/kgateway that referenced this pull request May 1, 2025
@rodrigc @MayorFaj
docs: add pointer to contributing guide in README (kgateway-dev#11126)
daed93e 
Signed-off-by: Craig Rodrigues <[email protected]>
MayorFaj added a commit to MayorFaj/kgateway that referenced this pull request May 5, 2025
@MayorFaj
Squashed commit of the following:
af4a2c1 
commit ec3f990
Author: Shashank Ram <[email protected]>
Date:   Fri May 2 15:50:15 2025 -0700

    Go: bump to 1.24.2 and use use errors.Join instead of go-multierror (kgateway-dev#11158)

    Signed-off-by: Shashank Ram <[email protected]>

commit 8d21b1f
Author: Shashank Ram <[email protected]>
Date:   Fri May 2 14:40:19 2025 -0700

    settings: enable setting xDS host instead of service FQDN (kgateway-dev#11156)

    Signed-off-by: Shashank Ram <[email protected]>

commit 6615dc2
Author: Ian Rudie <[email protected]>
Date:   Fri May 2 14:58:21 2025 -0400

    Waypoint Docs Update (kgateway-dev#11104)

    Signed-off-by: Ian Rudie <[email protected]>

commit fd9b343
Author: Tim Flannagan <[email protected]>
Date:   Fri May 2 11:58:00 2025 -0400

    Makefile: Fix invalid golangci-lint run arguments (kgateway-dev#11153)

    Signed-off-by: timflannagan <[email protected]>

commit f245a7a
Author: Craig Rodrigues <[email protected]>
Date:   Fri May 2 08:33:18 2025 -0700

    Add lint Makefile target and GitHub Action for Rust code (kgateway-dev#11135)

    Signed-off-by: Craig Rodrigues <[email protected]>

commit 15ea948
Author: Shashank Ram <[email protected]>
Date:   Thu May 1 14:50:49 2025 -0700

    policy/status: implement PolicyStatus API and reporting (kgateway-dev#11141)

    Signed-off-by: Shashank Ram <[email protected]>

commit 0c2b01c
Author: Tim Flannagan <[email protected]>
Date:   Thu May 1 14:05:24 2025 -0400

    internal/kgateway: Rename the routepolicy plugin directory (kgateway-dev#11147)

    Signed-off-by: timflannagan <[email protected]>

commit ea98802
Author: Omar Hammami <[email protected]>
Date:   Thu May 1 13:04:52 2025 -0500

    fix: compare backends of route ir (kgateway-dev#11145)

    Signed-off-by: omar <[email protected]>

commit 0917ffc
Author: Craig Rodrigues <[email protected]>
Date:   Thu May 1 09:56:42 2025 -0700

    docs: add pointer to contributing guide in README (kgateway-dev#11126)

    Signed-off-by: Craig Rodrigues <[email protected]>

commit c86ae03
Author: Steven Landow <[email protected]>
Date:   Thu May 1 08:41:47 2025 -0700

    allow multiple endpoint plugins to apply on a single backend (kgateway-dev#11144)

commit 4a800c5
Author: Yuval Kohavi <[email protected]>
Date:   Thu May 1 09:07:47 2025 -0400

    test: add applier tool (kgateway-dev#11143)

    Signed-off-by: Yuval Kohavi <[email protected]>

commit b3eec04
Author: Steven Landow <[email protected]>
Date:   Wed Apr 30 12:18:19 2025 -0700

    apply EndpointPlugins for non-EDS CLAs (kgateway-dev#11098)

    Signed-off-by: Steven Landow <[email protected]>
MayorFaj added a commit to MayorFaj/kgateway that referenced this pull request May 6, 2025
@MayorFaj
Squashed commit of the following:
acd5d34 
commit ec3f990
Author: Shashank Ram <[email protected]>
Date:   Fri May 2 15:50:15 2025 -0700

    Go: bump to 1.24.2 and use use errors.Join instead of go-multierror (kgateway-dev#11158)

    Signed-off-by: Shashank Ram <[email protected]>

commit 8d21b1f
Author: Shashank Ram <[email protected]>
Date:   Fri May 2 14:40:19 2025 -0700

    settings: enable setting xDS host instead of service FQDN (kgateway-dev#11156)

    Signed-off-by: Shashank Ram <[email protected]>

commit 6615dc2
Author: Ian Rudie <[email protected]>
Date:   Fri May 2 14:58:21 2025 -0400

    Waypoint Docs Update (kgateway-dev#11104)

    Signed-off-by: Ian Rudie <[email protected]>

commit fd9b343
Author: Tim Flannagan <[email protected]>
Date:   Fri May 2 11:58:00 2025 -0400

    Makefile: Fix invalid golangci-lint run arguments (kgateway-dev#11153)

    Signed-off-by: timflannagan <[email protected]>

commit f245a7a
Author: Craig Rodrigues <[email protected]>
Date:   Fri May 2 08:33:18 2025 -0700

    Add lint Makefile target and GitHub Action for Rust code (kgateway-dev#11135)

    Signed-off-by: Craig Rodrigues <[email protected]>

commit 15ea948
Author: Shashank Ram <[email protected]>
Date:   Thu May 1 14:50:49 2025 -0700

    policy/status: implement PolicyStatus API and reporting (kgateway-dev#11141)

    Signed-off-by: Shashank Ram <[email protected]>

commit 0c2b01c
Author: Tim Flannagan <[email protected]>
Date:   Thu May 1 14:05:24 2025 -0400

    internal/kgateway: Rename the routepolicy plugin directory (kgateway-dev#11147)

    Signed-off-by: timflannagan <[email protected]>

commit ea98802
Author: Omar Hammami <[email protected]>
Date:   Thu May 1 13:04:52 2025 -0500

    fix: compare backends of route ir (kgateway-dev#11145)

    Signed-off-by: omar <[email protected]>

commit 0917ffc
Author: Craig Rodrigues <[email protected]>
Date:   Thu May 1 09:56:42 2025 -0700

    docs: add pointer to contributing guide in README (kgateway-dev#11126)

    Signed-off-by: Craig Rodrigues <[email protected]>

commit c86ae03
Author: Steven Landow <[email protected]>
Date:   Thu May 1 08:41:47 2025 -0700

    allow multiple endpoint plugins to apply on a single backend (kgateway-dev#11144)

commit 4a800c5
Author: Yuval Kohavi <[email protected]>
Date:   Thu May 1 09:07:47 2025 -0400

    test: add applier tool (kgateway-dev#11143)

    Signed-off-by: Yuval Kohavi <[email protected]>

commit b3eec04
Author: Steven Landow <[email protected]>
Date:   Wed Apr 30 12:18:19 2025 -0700

    apply EndpointPlugins for non-EDS CLAs (kgateway-dev#11098)

    Signed-off-by: Steven Landow <[email protected]>

Signed-off-by: MayorFaj <[email protected]>
MayorFaj added a commit to MayorFaj/kgateway that referenced this pull request May 6, 2025
@MayorFaj
Squashed commit of the following:
bbb17db 
commit ec3f990
Author: Shashank Ram <[email protected]>
Date:   Fri May 2 15:50:15 2025 -0700

    Go: bump to 1.24.2 and use use errors.Join instead of go-multierror (kgateway-dev#11158)

    Signed-off-by: Shashank Ram <[email protected]>

commit 8d21b1f
Author: Shashank Ram <[email protected]>
Date:   Fri May 2 14:40:19 2025 -0700

    settings: enable setting xDS host instead of service FQDN (kgateway-dev#11156)

    Signed-off-by: Shashank Ram <[email protected]>

commit 6615dc2
Author: Ian Rudie <[email protected]>
Date:   Fri May 2 14:58:21 2025 -0400

    Waypoint Docs Update (kgateway-dev#11104)

    Signed-off-by: Ian Rudie <[email protected]>

commit fd9b343
Author: Tim Flannagan <[email protected]>
Date:   Fri May 2 11:58:00 2025 -0400

    Makefile: Fix invalid golangci-lint run arguments (kgateway-dev#11153)

    Signed-off-by: timflannagan <[email protected]>

commit f245a7a
Author: Craig Rodrigues <[email protected]>
Date:   Fri May 2 08:33:18 2025 -0700

    Add lint Makefile target and GitHub Action for Rust code (kgateway-dev#11135)

    Signed-off-by: Craig Rodrigues <[email protected]>

commit 15ea948
Author: Shashank Ram <[email protected]>
Date:   Thu May 1 14:50:49 2025 -0700

    policy/status: implement PolicyStatus API and reporting (kgateway-dev#11141)

    Signed-off-by: Shashank Ram <[email protected]>

commit 0c2b01c
Author: Tim Flannagan <[email protected]>
Date:   Thu May 1 14:05:24 2025 -0400

    internal/kgateway: Rename the routepolicy plugin directory (kgateway-dev#11147)

    Signed-off-by: timflannagan <[email protected]>

commit ea98802
Author: Omar Hammami <[email protected]>
Date:   Thu May 1 13:04:52 2025 -0500

    fix: compare backends of route ir (kgateway-dev#11145)

    Signed-off-by: omar <[email protected]>

commit 0917ffc
Author: Craig Rodrigues <[email protected]>
Date:   Thu May 1 09:56:42 2025 -0700

    docs: add pointer to contributing guide in README (kgateway-dev#11126)

    Signed-off-by: Craig Rodrigues <[email protected]>

commit c86ae03
Author: Steven Landow <[email protected]>
Date:   Thu May 1 08:41:47 2025 -0700

    allow multiple endpoint plugins to apply on a single backend (kgateway-dev#11144)

commit 4a800c5
Author: Yuval Kohavi <[email protected]>
Date:   Thu May 1 09:07:47 2025 -0400

    test: add applier tool (kgateway-dev#11143)

    Signed-off-by: Yuval Kohavi <[email protected]>

commit b3eec04
Author: Steven Landow <[email protected]>
Date:   Wed Apr 30 12:18:19 2025 -0700

    apply EndpointPlugins for non-EDS CLAs (kgateway-dev#11098)

    Signed-off-by: Steven Landow <[email protected]>

commit 9b2f9a5
Author: Yuval Kohavi <[email protected]>
Date:   Tue Apr 29 16:49:00 2025 -0400

    use set_metadata for extauth global disable (kgateway-dev#11132)

    Signed-off-by: Yuval Kohavi <[email protected]>

commit eacb082
Author: Craig Rodrigues <[email protected]>
Date:   Tue Apr 29 11:29:45 2025 -0700

    Fix rustfmt and clippy lint issues (kgateway-dev#11137)

    Signed-off-by: Craig Rodrigues <[email protected]>

commit f4f9e28
Author: Yossi Mesika <[email protected]>
Date:   Tue Apr 29 20:07:09 2025 +0300

    Support sending from Ingress to Waypoint (kgateway-dev#11114)

    Signed-off-by: Yossi Mesika <[email protected]>

commit f7509d7
Author: Nina Polshakova <[email protected]>
Date:   Tue Apr 29 14:59:29 2025 +0000

    Follow up unit test clean up (kgateway-dev#11123)

    Signed-off-by: npolshakova <[email protected]>

commit 6cb05af
Author: Shashank Ram <[email protected]>
Date:   Mon Apr 28 10:27:54 2025 -0700

    status: correctly merge parentRefs for routes (kgateway-dev#11130)

    Signed-off-by: Shashank Ram <[email protected]>

Signed-off-by: MayorFaj <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timflannagan timflannagan timflannagan approved these changes

@nfuden nfuden nfuden approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rodrigc @timflannagan @nfuden