kubernetes-sigs / network-policy-api

This repo addresses further work involving Kubernetes network security beyond the initial NetworkPolicy resource
Apache License 2.0
54 stars 29 forks source link

Add Links to Contributing and Developer Guides in README #53

Closed cailynse closed 1 year ago

cailynse commented 1 year ago

solves: #49

I've added a very small sentence to link to the contributing guidelines and developer guide - is this what you were thinking or would you like additional detail on how to contribute?

Note that the contributing guidelines are also linked when someone (like me!) opens their first PR on the repo. Should we avoid the duplication, or is the link useful before someone gets to the point of creating a PR?

Screenshot 2022-11-02 at 3 50 52 PM

netlify[bot] commented 1 year ago

Deploy Preview for kubernetes-sigs-network-policy-api ready!

Name Link
Latest commit 0b4d44e8e6d76081697d3fc8483f3a02bec918bc
Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-network-policy-api/deploys/6362cabfff631f000a50e41f
Deploy Preview https://deploy-preview-53--kubernetes-sigs-network-policy-api.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

rikatz commented 1 year ago

I think adding the contrib guideline is fine as sometimes people look for that before really opening the PR

/lgtm /approve Thanks

k8s-ci-robot commented 1 year ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cailynse, rikatz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubernetes-sigs/network-policy-api/blob/master/OWNERS)~~ [rikatz] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
astoycos commented 1 year ago

No this is perfect, thanks @cailynse!!!

Also our README generally isn't that nice at the moment if you have time/ want to tackle something definitely feel free to!

At the very least we should be pointing folks to our website -> https://network-policy-api.sigs.k8s.io/