Skip to content

docs: adopt the org's <type>: summary commit convention #816

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: adopt the org's <type>: summary commit convention #816

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
3 changes: 2 additions & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,13 @@ bisectable, revertable).
git checkout main && git pull opus main
git checkout -b <type>/<short-name>
# ... make exactly one change, test it ...
git commit -am "Short title — what & why"
git commit -am "<type>: short imperative summary"
git push -u opus <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`.
- **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
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ into `main`. Never commit directly to `main`.
git checkout main && git pull origin main
git checkout -b <type>/<short-name>
# make exactly one logical change
git commit -am "Short title — what & why"
git commit -am "<type>: short imperative summary"
git push -u origin <type>/<short-name>
# open PR, squash-merge, delete branch
```

**Branch prefixes:** `fix/`, `refactor/`, `docs/`, `cleanup/`, `feat/`, `test/`.
**Types** (branch prefix and commit/PR title alike): `feat`, `fix`, `perf`,
`refactor`, `docs`, `test`, `build`, `chore`.

**One logical change per PR** — independently reviewable, bisectable, revertable.

Expand Down Expand Up @@ -80,7 +81,8 @@ image build).

## Commit messages

- Short title (imperative mood) — what changed and why.
- Title is `<type>: short imperative summary`, using the types listed above —
the PR title matches it, since the squash-merge keeps it as the commit title.
- Body is optional; use it for context that isn't obvious from the diff.
- No issue/PR numbers in the title — GitHub adds the PR number on squash-merge.

Expand Down