pr
- Repo stars 534
- Author repo couchers
- Domain
- Engineering
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 88 / 100 · heuristic scan, not runtime safety proof
- Runtime evidence
- Not run; no isolated runtime test evidence is currently recorded
- Author / version / license
- @Couchers-org · no license declared
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No explicit requirements detected
- Detected file/system behavior
-
- Read-only
- Write / modify
- Env read
- Network behavior
- Local-only
- Install commands
- None (reference only)
Heads up: Tool permissions are not declared; actual access depends on the runtime.
# Create a Pull Request
Create a branch, commit, push, and open a PR for the current changes.
## Steps
### 1. Assess the current state
Run in parallel:
- `git status` (never use `-uall`)
- `git diff` and `git diff --staged` to understand all changes
- `git log --oneline -5` to see recent commit message style
Identify which files should be committed. Do NOT commit files that are:
- Scratch/debug/temporary files
- Files containing secrets (`.env`, credentials, etc.)
If there are no meaningful changes to commit, tell the user and stop.
### 2. Determine the branch name
Branch names in this repo follow the pattern: `<area>/<type>/<short-description>`
Where:
- `<area>` is one of: `backend`, `web`, `frontend`, `mobile`, `devops`, `docs`, or another area that matches the changed files. For cross-cutting changes spanning multiple areas, pick the one that best describes the change.
- `<type>` is one of: `feature`, `bugfix`, `fix`, `refactor`, or similar
- `<short-description>` is a short kebab-case description
Infer area and type from the changed files and the nature of the changes. Never use a username as the area.
### 3. Run linters and formatters
Before committing, run the appropriate linters and formatters for the changed areas:
- **Backend**: `make format` and `make mypy` from `/app/backend`
- **Web/Frontend**: lint/format as appropriate
Fix any issues before proceeding. If linters produce changes, include those in the commit.
### 4. Create the branch and commit
If there are already commits on the current branch and no uncommitted changes remain (e.g. changes were already committed earlier), skip the commit and proceed to pushing.
Otherwise:
```
git checkout -b <branch-name>
git add <specific files> # add only the relevant files by name
git commit -m "<message>"
```
Write a concise commit message (1-2 sentences) that describes what changed and why.
### 5. Push the branch
```
git push -u origin <branch-name>
```
### 6. Create the PR
Read the PR template from `.github/pull_request_template.md` in this repo. Fill it in based on the actual changes:
- Fill in the description at the top (what and why)
- Fill in the Testing section with what was done or what should be done
- Include the appropriate checklist(s) — backend, web, or both — based on which areas were changed. Remove checklists that don't apply.
- Keep the "For maintainers" section as-is
- Append the following note as the very last line of the PR body, after the "For maintainers" section (separated by a blank line):
```
_This PR was created with the Couchers PR skill._
```
```bash
gh pr create --base develop --title "<short title>" --body "$(cat <<'EOF'
<filled-in PR template>
_This PR was created with the Couchers PR skill._
EOF
)"
```
### 7. Report back
Tell the user the PR URL when done.
Sections and files
Listed in source order.
sections -> Steps → 1. Assess the current state → 2. Determine the branch name → 3. Run linters and formatters → 4. Create the branch and commit → 5. Push the branch
terms -> Backend · Web/Frontend · Create a branch, commit, push, and open a PR for the current changes. · Identify which files should be committed. · If there are no meaningful changes to commit, tell the user and stop. · Where: - <area> is one of: backend, web, frontend, mobile, devops, docs, or another area that matches the changed files. · Infer area and type from the changed files and the nature of the changes. · Fix any issues before proceeding.
files/cmd -> git status · -uall · git diff · git diff --staged · git log --oneline -5 · .env · <area>/<type>/<short-description> · <area>
body sha256 -> 713e8ba0cfae
1. Assess the current state
Run in parallel:
git status(never use-uall)git diffandgit diff --stagedto understand all changesgit log --oneline -5to see recent commit message style Identify which files should be committed. Do NOT commit files that are:2. Determine the branch name
Branch names in this repo follow the pattern:
<area>/<type>/<short-description>Where:<area>is one of:backend,web,frontend,mobile,devops,docs, or another area that matches the changed files. For cross-cutting changes spanning multiple areas, pick the one that best describes the change.<type>is one of:feature,bugfix,fix,refactor, or similar<short-description>is a short kebab-case description3. Run linters and formatters
Before committing, run the appropriate linters and formatters for the changed areas: Backend:
make formatandmake mypyfrom/app/backendWeb/Frontend: lint/format as appropriate Fix any issues before proceeding. If linters produce changes, include those in the commit.4. Create the branch and commit
If there are already commits on the current branch and no uncommitted changes remain (e.g. changes were already committed earlier), skip the commit and proceed to pushing. Otherwise: Write a concise commit message (1-2 sentences) that describes what changed and why.
6. Create the PR
Read the PR template from
.github/pull_request_template.mdin this repo. Fill it in based on the actual changes: Fill in the description at the top (what and why) Fill in the Testing section with what was done or what should be done Include the appropriate checklist(s) — backend, web, or both — based on which areas were changed. Remove checklists that don't apply. Keep the "For maintainers" section as-is