Update CONTRIBUTING.md and add install instructions to README.md#49
Update CONTRIBUTING.md and add install instructions to README.md#49adamwg wants to merge 2 commits into
Conversation
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
|
Warning Review limit reached
More reviews will be available in 55 minutes and 22 seconds. 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. 📝 WalkthroughWalkthroughThis PR expands the Crossplane CLI's documentation by replacing the brief CONTRIBUTING.md pointer with a full contributor guide covering command structure, kong framework conventions, maturity levels, and documentation standards; and by adding Installation and Reference Documentation sections to the README.md for end users. ChangesCrossplane CLI Documentation Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error)
✅ Passed checks (5 passed)
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
Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
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)
| tags] can be used to control many behaviors, including validation, | ||
| auto-completion, and documentation. | ||
|
|
||
| ## Command Maturity Levels |
There was a problem hiding this comment.
We should also mention that commands without maturity level inherit it from their parent
| 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
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.