Review Contributing docs #966
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nhennigan
reviewed
Jan 15, 2025
| @@ -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?
HomayoonAlimohammadi
approved these changes
Jan 16, 2025
There was a problem hiding this comment.
Great work, thanks a lot @eaudetcobello! LGTM overall. Left some minor comments.
|
|
||
| 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.
|
I think @HomayoonAlimohammadi comments are very relevant. Once they are addressed I think we can merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Expands the Contributing page, adds a CONTRIBUTING.md that links to the Contributing page.