64898b2c79
Some checks failed
Code scanning / CodeQL (push) Failing after 15s
Zulip production suite / Ubuntu 22.04 production build (push) Failing after 26s
Zulip production suite / Debian 12 production install with custom db name and user (push) Has been skipped
Zulip production suite / Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga (push) Has been skipped
Zulip production suite / Ubuntu 24.04 production install (push) Has been skipped
Zulip production suite / Ubuntu 26.04 production install (push) Has been skipped
Zulip production suite / Debian 13 production install (push) Has been skipped
Zulip production suite / 7.0 Version Upgrade (push) Has been skipped
Zulip production suite / 8.0 Version Upgrade (push) Has been skipped
Zulip production suite / 6.0 Version Upgrade (push) Has been skipped
Zulip production suite / 10.0 Version Upgrade (push) Has been skipped
Zulip production suite / 9.0 Version Upgrade (push) Has been skipped
Zulip production suite / 12.0 Version Upgrade (push) Has been skipped
Zulip production suite / 11.0 Version Upgrade (push) Has been skipped
GitHub Actions Security Analysis with zizmor / zizmor (push) Failing after 3s
Zulip CI / Debian 12 (Python 3.11, backend + documentation) (push) Failing after 26s
Zulip CI / Ubuntu 22.04 (Python 3.10, backend + frontend) (push) Failing after 3s
Zulip CI / Ubuntu 24.04 (Python 3.12, backend) (push) Failing after 25s
Zulip CI / Ubuntu 26.04 (Python 3.14, backend) (push) Failing after 25s
Zulip CI / Debian 13 (Python 3.13, backend) (push) Failing after 28s
Zulip production suite / Required jobs (push) Has been cancelled
Zulip CI / Required jobs (push) Has been cancelled
API Documentation Update Check / check-feature-level-updated (push) Has been cancelled
API Documentation Update Check / notify-if-api-docs-changed (push) Has been cancelled
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
---
|
|
name: commit-message
|
|
description: "Write a commit message following Zulip's format. Use whenever writing or rewording any commit message."
|
|
---
|
|
|
|
# Commit Message Format
|
|
|
|
```
|
|
subsystem: Summary in 72 characters or less.
|
|
|
|
The body explains why and how. Include context that helps reviewers
|
|
and future developers understand your reasoning, analysis, and
|
|
verification of the work above and beyond CI, without repeating
|
|
details already well presented in the commit metadata (filenames,
|
|
etc.). Explain what the change accomplishes and why it won't break
|
|
things one might worry about.
|
|
|
|
Line-wrap at 68-70 characters, except URLs and verbatim content
|
|
(error messages, etc.).
|
|
|
|
Fixes #123.
|
|
```
|
|
|
|
## Commit summary format
|
|
|
|
- Before the colon is a lower-case brief gesture at subsystem (ex: "nginx" config) or
|
|
feature (ex: "compose" for the compose box) being modified.
|
|
- Use a period at the end of the summary
|
|
- Example: `compose: Fix cursor position after emoji insertion.`
|
|
- Example: `nginx: Refactor immutable cache headers.`
|
|
- Bad examples: `Fix bug`, `Update code`, `gather_subscriptions was broken`
|
|
|
|
## Linking issues
|
|
|
|
- `Fixes #123.` - Automatically closes the issue
|
|
- `Fixes part of #123.` - Does not close (for partial fixes)
|
|
- In a multi-commit PR, use `Fixes part of #123.` in earlier commits
|
|
and `Fixes #123.` in the final commit.
|
|
- Never: `Partially fixes #123.` (GitHub ignores "partially")
|