Skip to content

docs: use giget for single example clone#474

Merged
chenjiahan merged 2 commits into
mainfrom
chenjiahan/docs-use-giget
Jun 15, 2026
Merged

docs: use giget for single example clone#474
chenjiahan merged 2 commits into
mainfrom
chenjiahan/docs-use-giget

Conversation

@chenjiahan

Copy link
Copy Markdown
Member

Summary

This PR updates the README single-example cloning instructions to use giget instead of gitpick. It also clarifies the output directory argument and adds a couple of example clone commands for other packages.

Validation

  • pnpm exec prettier -c README.md

@chenjiahan chenjiahan marked this pull request as ready for review June 15, 2026 08:50
@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 519b73e6-ffa7-4c30-aff1-6458b7cca5e9

📥 Commits

Reviewing files that changed from the base of the PR and between 22571d0 and 9febc2d.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README's "Clone single example" section is updated to replace gitpick with giget. The primary command example is changed to npx giget ... my-app targeting rspack/basic. A clarification is added stating that the second argument specifies the output directory, and two additional giget command examples are provided for cloning the Rsbuild React and Rslib React examples.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: updating README documentation to use giget instead of gitpick for single example cloning.
Description check ✅ Passed The description is clearly related to the changeset, providing context about the tool replacement from gitpick to giget and mentioning clarifications and additional examples.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chenjiahan/docs-use-giget

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 27-30: The directory navigation command has a mismatch: the giget
clone command on line 27 creates a directory named `my-app`, but the cd command
on line 30 attempts to navigate to `basic`, which does not exist. Change the cd
command to match the actual output directory by replacing `cd basic` with `cd
my-app` to ensure users can successfully navigate into the cloned example
directory.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c356021e-b5ea-41ac-861c-a6194001a3ae

📥 Commits

Reviewing files that changed from the base of the PR and between 2a57932 and 22571d0.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 22571d0fae

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
@chenjiahan chenjiahan merged commit 8b6a2f9 into main Jun 15, 2026
3 checks passed
@chenjiahan chenjiahan deleted the chenjiahan/docs-use-giget branch June 15, 2026 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant