docs(skills): enhance pr-creator safety and interactivity (#18616)

This commit is contained in:
N. Taylor Mullen
2026-02-09 21:38:10 -08:00
committed by GitHub
parent bd2744031f
commit 4a3c7ae8b7
+29 -9
View File
@@ -14,25 +14,34 @@ repository's standards.
Follow these steps to create a Pull Request: Follow these steps to create a Pull Request:
1. **Branch Management**: Check the current branch to avoid working directly 1. **Branch Management**: **CRITICAL:** Ensure you are NOT working on the
on `main`. `main` branch.
- Run `git branch --show-current`. - Run `git branch --show-current`.
- If the current branch is `main`, create and switch to a new descriptive - If the current branch is `main`, you MUST create and switch to a new
branch: descriptive branch:
```bash ```bash
git checkout -b <new-branch-name> git checkout -b <new-branch-name>
``` ```
2. **Locate Template**: Search for a pull request template in the repository. 2. **Commit Changes**: Verify that all intended changes are committed.
- Run `git status` to check for unstaged or uncommitted changes.
- If there are uncommitted changes, stage and commit them with a descriptive
message before proceeding. NEVER commit directly to `main`.
```bash
git add .
git commit -m "type(scope): description"
```
3. **Locate Template**: Search for a pull request template in the repository.
- Check `.github/pull_request_template.md` - Check `.github/pull_request_template.md`
- Check `.github/PULL_REQUEST_TEMPLATE.md` - Check `.github/PULL_REQUEST_TEMPLATE.md`
- If multiple templates exist (e.g., in `.github/PULL_REQUEST_TEMPLATE/`), - If multiple templates exist (e.g., in `.github/PULL_REQUEST_TEMPLATE/`),
ask the user which one to use or select the most appropriate one based on ask the user which one to use or select the most appropriate one based on
the context (e.g., `bug_fix.md` vs `feature.md`). the context (e.g., `bug_fix.md` vs `feature.md`).
3. **Read Template**: Read the content of the identified template file. 4. **Read Template**: Read the content of the identified template file.
4. **Draft Description**: Create a PR description that strictly follows the 5. **Draft Description**: Create a PR description that strictly follows the
template's structure. template's structure.
- **Headings**: Keep all headings from the template. - **Headings**: Keep all headings from the template.
- **Checklists**: Review each item. Mark with `[x]` if completed. If an item - **Checklists**: Review each item. Mark with `[x]` if completed. If an item
@@ -44,14 +53,24 @@ Follow these steps to create a Pull Request:
- **Related Issues**: Link any issues fixed or related to this PR (e.g., - **Related Issues**: Link any issues fixed or related to this PR (e.g.,
"Fixes #123"). "Fixes #123").
5. **Preflight Check**: Before creating the PR, run the workspace preflight 6. **Preflight Check**: Before creating the PR, run the workspace preflight
script to ensure all build, lint, and test checks pass. script to ensure all build, lint, and test checks pass.
```bash ```bash
npm run preflight npm run preflight
``` ```
If any checks fail, address the issues before proceeding to create the PR. If any checks fail, address the issues before proceeding to create the PR.
6. **Create PR**: Use the `gh` CLI to create the PR. To avoid shell escaping 7. **Push Branch**: Push the current branch to the remote repository.
**CRITICAL SAFETY RAIL:** Double-check your branch name before pushing.
NEVER push if the current branch is `main`.
```bash
# Verify current branch is NOT main
git branch --show-current
# Push non-interactively
git push -u origin HEAD
```
8. **Create PR**: Use the `gh` CLI to create the PR. To avoid shell escaping
issues with multi-line Markdown, write the description to a temporary file issues with multi-line Markdown, write the description to a temporary file
first. first.
```bash ```bash
@@ -68,6 +87,7 @@ Follow these steps to create a Pull Request:
## Principles ## Principles
- **Safety First**: NEVER push to `main`. This is your highest priority.
- **Compliance**: Never ignore the PR template. It exists for a reason. - **Compliance**: Never ignore the PR template. It exists for a reason.
- **Completeness**: Fill out all relevant sections. - **Completeness**: Fill out all relevant sections.
- **Accuracy**: Don't check boxes for tasks you haven't done. - **Accuracy**: Don't check boxes for tasks you haven't done.