Skip to content

docs: document PR base-branch pitfall for forked template projects #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhnns merged 1 commit into from
Aug 8, 2026
Merged

docs: document PR base-branch pitfall for forked template projects #111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,18 @@ git remote set-url --push template DISABLED

Verify with `git remote -v`: `template` should show a normal fetch URL and `DISABLED` (or empty) for push.

## Opening pull requests

Projects generated from this template are **GitHub forks** of `peerigon/template`, so both the web UI's compare page and a fresh `gh` checkout default a new pull request's base to the **upstream** repo (`peerigon/template`). A PR opened that way targets the template, and checks that depend on the fork's repo (CODEOWNERS, rulesets) then fail against the wrong repository.

Run this once per clone of the forked repo:

```bash
gh repo set-default <owner>/<repo>
```

After that `gh pr create` targets the fork. The web UI keeps preselecting the upstream — always confirm the base is `<owner>/<repo>` before creating a PR there, or use `gh pr create --repo <owner>/<repo>`.

## Pulling Updates from Template

If the user is asking you to pull in updates from the template repository, follow the steps below.
Expand Down