Skip to content

chore: add explicit clone command to README#21

Open
nicomiguelino wants to merge 1 commit intomainfrom
chore/add-clone-command-to-readme
Open

chore: add explicit clone command to README#21
nicomiguelino wants to merge 1 commit intomainfrom
chore/add-clone-command-to-readme

Conversation

@nicomiguelino
Copy link
Copy Markdown
Contributor

Closes #18

Replaces the link to the submodule README with an inline gh repo clone command that includes --recurse-submodules, reducing friction for newcomers.

- Replace submodule link with inline gh repo clone command
- Add note to install dependencies after cloning
@nicomiguelino nicomiguelino self-assigned this May 5, 2026
@nicomiguelino nicomiguelino requested a review from Copilot May 5, 2026 15:05
@nicomiguelino nicomiguelino marked this pull request as ready for review May 5, 2026 15:05
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the onboarding instructions to explicitly show how to clone this repository with submodules, reducing setup friction for new contributors (per Issue #18).

Changes:

  • Replaces the submodule README link with an inline gh repo clone ... --recurse-submodules command.
  • Keeps the existing dependency installation step immediately after the clone instructions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

chore: add explicit clone command to README

2 participants