Update CONTRIBUTING.md and add install instructions to README.md#49
Conversation
|
Warning Review limit reached
More reviews will be available in 9 minutes and 1 second. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR expands CONTRIBUTING.md into a full Crossplane CLI contributor guide (command structure, kong usage, maturity, Help() docs, generate-docs, and vale linting) and adds Installation and Reference Documentation sections to README.md. ChangesCrossplane CLI Documentation Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 31-35: The README shows inconsistent variable names for installing
the latest build: it mentions XP_CHANNEL=master but the example command uses
XP_VERSION=master; update the example so both use the same environment variable
(choose XP_CHANNEL or XP_VERSION consistently), e.g., replace XP_VERSION=master
in the curl pipe command with XP_CHANNEL=master (or vice versa) so the README's
instruction and the command match and will work as documented.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 7fedac0f-ed32-45c8-9e3b-02d40cc5c392
📒 Files selected for processing (2)
CONTRIBUTING.mdREADME.md
tampakrap
left a comment
tampakrap
left a comment
There was a problem hiding this comment.
in general it looks good, I left some minor comments, thanks for taking the time to write this!
Another comment (that can be addressed in a follow-up PR), we should add instructions for development, eg how to run tests and build/install a local version.
|
|
||
| Welcome to the Crossplane CLI, and thank you for your interest in contributing. | ||
|
|
||
| Please start by reading the [Crossplane contributing document]. The Crossplane |
There was a problem hiding this comment.
I'd prefer this would be only a suggestion instead of a hard requirement. Newcomers might / should not know what is applicable and what is not from the other contributing docs, so I'd prefer to duplicate here the relevant parts (or to put specific links, but I guess it would be difficult to maintain, so I personally prefer the duplication)
There was a problem hiding this comment.
I think this makes sense. I worry a bit about coding style guidelines in particular diverging, but the coding style in Crossplane is pretty settled and evolves slowly, so I think the risk is low.
Can we handle this as a follow-up? I think we can copy over most of what we need from c/c, but organizing the content nicely will take some thought.
There was a problem hiding this comment.
I believe coding style (and maybe more parts that are equally stable) could possibly be just a link, but an explicit reference so that it's clear that they are relevant to the CLI as well. In any case, I'm fine handling that in a followup PR so we can proceed with this one.
| If in doubt about whether your help will look good, you can easily check your | ||
| work by cloning the [crossplane/docs](https://github.com/crossplane/docs) repo, | ||
| running `crossplane generate-docs -o content/master/cli/command-reference.md` to | ||
| update the CLI reference section, and then running `hugo serve` to preview it | ||
| locally. |
There was a problem hiding this comment.
maybe to convert that to a list of commands? So that it is more clear on where to run each command
|
Actionable comments posted: 0 |
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
|
Rebased to (hopefully) make the |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 43-46: Update the wording to accurately reflect the maturity-level
visibility behavior: change the first bullet so it states that any non-enabled
maturity level (e.g., alpha and beta) is hidden from help output by default
unless explicitly enabled in CLI configuration (instead of saying only alpha is
hidden); keep the second bullet about notes being added for alpha and beta, and
add the inheritance sentence (“If a command is not tagged with a maturity level,
it will inherit from its parent in the command tree; commands without a maturity
level anywhere in their tree are considered GA”) to clarify defaulting rules;
ensure you edit the lines that currently read “Alpha commands are hidden from
the help output by default…” and the maturity-note sentence so the document and
actual maturity logic match.
- Around line 91-92: Update the sentence "Build the docs serve them locally for
preview." to read "Build the docs and serve them locally for preview." so the
local preview step is grammatically correct; locate the header line shown in the
diff and replace the phrase accordingly (the line containing "hugo serve" and
the preceding sentence).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: e0c6e929-ab38-4d25-9997-0a1fe51e3374
📒 Files selected for processing (2)
CONTRIBUTING.mdREADME.md
✅ Files skipped from review due to trivial changes (1)
- README.md
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
tampakrap
left a comment
tampakrap
left a comment
There was a problem hiding this comment.
thanks for addressing my comments! LGTM, the rest can be handled in followup PRs
2 participants
Description of your changes
Our original
CONTRIBUTING.mddoc just pointed to the core Crossplanecontributing documentation. Update it to also include some CLI-specific content.
While we're updating docs, add installation instructions to
README.md.I have:
./nix.sh flake checkto ensure this PR is ready for review.- [ ] Added or updated unit tests.- [ ] Linked a PR or a docs tracking issue to document this change.- [ ] Addedbackport release-x.ylabels to auto-backport this PR.