Review Contributing docs #966
Conversation
| @@ -0,0 +1,5 @@ | |||
| # Contributing to Canonical Kubernetes | |||
There was a problem hiding this comment.
Does Canonical have a standard way to create a CONTRIBUTE.md file?
There was a problem hiding this comment.
Great work, thanks a lot @eaudetcobello! LGTM overall. Left some minor comments.
|
|
||
| go 1.23.0 | ||
|
|
||
| replace github.com/canonical/k8s-snap-api => /home/user/ubuntu/k8s-snap/src/k8s/k8s-snap-api |
There was a problem hiding this comment.
nit: Maybe we can replace this with something like /path/to/local/clone/of/k8s-snap-api?
|
|
||
| 4. Create a separate PR in the `k8s-snap-api` repository with your API changes. | ||
|
|
||
| 5. Reference your `k8s-snap-api` PR in your main `k8s-snap` PR. |
There was a problem hiding this comment.
Maybe we can also add:
6. Once the k8s-snap-api PR is merged and tagged, remove the replace directive and update k8s-snap-api version in your k8s-snap PR
Or something like this.
| * Contains only changes that are relevant to the PRs stated purpose | ||
| * Updates relevant documentation | ||
|
|
||
| Draft PRs are welcome for early feedback, please mark them as such. |
There was a problem hiding this comment.
Oh I thought draft PRs are there to say "please don't review me, I'm not finished yet and I might be embarrassing".
BTW this might not be the case since Kubernetes team will be mentioned as the reviewer upon creating a draft PR (I don't think you can prevent this as a user).
Expands the Contributing page, adds a CONTRIBUTING.md that links to the Contributing page.