nemoclaw-contributor-create-pr

Files (1)

• SKILL.md

SKILL.md (first lines)

# Create GitHub Pull Request

Create pull requests on the NemoClaw GitHub repository using the `gh` CLI. This skill ensures every PR follows the project's PR template exactly.

## Prerequisites

- The `gh` CLI must be authenticated (`gh auth status`).
- You must be in the NemoClaw git repository.
- You must have commits on a branch that is pushed to the remote.

## Step 1: Verify Branch State

Before creating a PR, verify the branch.

1. **Not on main.** Never create PRs from main.

   ```bash
   git branch --show-current
   ```

2. **Branch has commits ahead of main.**

   ```bash
   git log main..HEAD --oneline
   ```

3. **Working tree is clean.** Stage or stash any uncommitted changes first.

   ```bash
   git status
   ```

## Step 2: Run Pre-PR Checks

Choose checks based on the files changed.

For code changes, run both checks and confirm they pass before proceeding:

```bash
npx prek run --all-files
npm test
```

For doc-only changes, do not run the full test suite unless the docs change requires it.
Run the docs and hook checks instead:

```bash
npx prek run --all-files
npm run docs
```

If a required check fails, fix the issue before creating the PR.
When preparing the PR body for a doc-only change, leave the `npm test` verification box unchecked unless you actually ran it.

## Step 3: Push the Branch

Ensure the branch is pushed to the remote.

```bash
git push -u origin HEAD
```

## Step 4: Determine PR Metadata

### Title

PR titles must follow Conventional Commits format:

```text
<type>(<scope>): <description>
```

Types: `feat`, `fix`, `docs`, `chore`, `refactor`, `test`, `ci`, `perf`

Scope is typically the component name (e.g., `cli`, `blueprint`, `plugin`, `policy`, `docs`).

Examples:

- `feat(cli): add offline mode for onboarding`
- `fix(blueprint): prevent SSRF bypass via redirect`
- `docs: update quickstart for Windows prerequisites`

### Type of Change

Determine which type applies based on the diff:

- **Code change for a new feature, bug fix, or refactor** — most PRs.
- **Code change with doc updates** — code plus changes under `docs/`.
- **Doc only, prose changes without code sample modifications** — only Markdown prose.
- **Doc only, includes code sample changes** — doc changes that modify fenced code blocks.

### Related Issue

Check the branch name and commit messages for issue references. If an issue exists, use `Fixes #NNN` or `Closes #NNN`.

### DCO Sign-Off

The PR body must include a DCO sign-off line. Determine the user's name and email from git config:

```bash
git config user.name
git config user.email
```

## Step 5: Compose the PR Body

Use the exact template structure below. Fill in each section based on the diff (`git diff main...HEAD`). Check the applicable boxes and leave others unchecked. Do not add, remove, or reorganize sections.

```markdown
## Summary
<!-- 1-3 sentences: what this PR does and why. -->

## Related Issue
<!-- Fixes #NNN or Closes #NNN. Remove this section if none. -->

## Changes
<!-- Bullet list of key changes. -->

## Type of Change

From YYC-Cube/YYC3-NemoClaw, Apache-2.0.

More from YYC-Cube/YYC3-NemoClaw