Skip to content

docs: name the fork remote origin, as the docs already assume #819

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
blaipr merged 1 commit into from
Aug 18, 2026
Merged

docs: name the fork remote origin, as the docs already assume #819

Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ is a **separate PR**, squash-merged. One logical change per PR (independently re
bisectable, revertable).

```bash
git checkout main && git pull opus main
git checkout main && git pull origin main
git checkout -b <type>/<short-name>
# ... make exactly one change, test it ...
git commit -am "<type>: short imperative summary"
git push -u opus <type>/<short-name>
git push -u origin <type>/<short-name>
gh pr create --repo OpusProjects/sysPass --base main --head <type>/<short-name> --title "..." --body "..."
gh pr merge <n> --repo OpusProjects/sysPass --squash --delete-branch # we self-merge
```

- **Types** (branch prefix and commit/PR title alike): `feat`, `fix`, `perf`, `refactor`, `docs`, `test`, `build`, `chore` — as in every OpusProjects repo.
- **Remotes:** `origin` = upstream `nuxsmin/sysPass` (read-only) · `opus` = our fork `OpusProjects/sysPass` (push here). Default branch: `main`.
- **Remotes:** `origin` = our fork `OpusProjects/sysPass` (push here) · `upstream` = `nuxsmin/sysPass` (read-only). Default branch: `main`.
- **Git identity** is set repo-locally (`blaipr` / `blaipr@hotmail.com`) — plain `git commit` works.
- `gh pr edit` can silently no-op on this repo (classic-Projects GraphQL field); if a body edit doesn't apply, PATCH via `gh api -X PATCH repos/OpusProjects/sysPass/pulls/<n> -F body=@file`.

Expand Down
10 changes: 5 additions & 5 deletions docs/github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ workflow reacts to.

```bash
git tag v4.0.1
git push opus v4.0.1
git push origin v4.0.1
```

The tag runs the full pipeline, and then two jobs behave differently than they do on a pull request:
Expand Down Expand Up @@ -175,17 +175,17 @@ Every change is its own pull request, squash-merged, and independently reviewabl
revertable — a dependency bump, a fix and a documentation edit each get their own.

```bash
git checkout main && git pull opus main
git checkout main && git pull origin main
git checkout -b <type>/<short-name>
# ... make exactly one change, and test it ...
git commit -am "Short title — what and why"
git push -u opus <type>/<short-name>
git commit -am "<type>: short imperative summary"
git push -u origin <type>/<short-name>
gh pr create --repo OpusProjects/sysPass --base main --head <type>/<short-name> --title "..." --body "..."
gh pr merge <n> --repo OpusProjects/sysPass --squash --delete-branch
```

Branch names are `<type>/<short-name>` and titles are `<type>: short imperative summary`, drawn from
`feat`, `fix`, `perf`, `refactor`, `docs`, `test`, `build` and `chore`. The remotes are `origin` for
read-only upstream `nuxsmin/sysPass` and `opus` for this fork, which is where everything is pushed.
this fork, which is where everything is pushed, and `upstream` for the read-only `nuxsmin/sysPass`.

[CONTRIBUTING.md](../CONTRIBUTING.md) covers development setup and coding conventions in full.