Commit Message Format

This page is not authoritative. It is rather a collection of reasonable suggestions. Feel free to contribute to this page.

There's little technical merit to a standardized commit log format, except for much easier grepping. What we should value here is tradition.

Overview

- Did that
- And that

Field one: value
Field two: value

General points

Do

PR:           12345
Approved by:  John Doe <john@doe.org> (maintainer)
Approved by:  phk (maintainer, implicit)
Approved by:  portmgr (erwin)
Approved by:  Dow Jones (maintainer timeout, 25 days)
Submitted by: Jane Doe <jane@doe.org>

Don't

Approved by:  maintainer
Approved by:  maintainer timeout
Approved by:  erwin (portmgr)

Special

Reported by:  pointyhat via kris
Reported by:  pointyhat logs
Reported by:  portsmon
Submitted by: Ports Fury

Case studies

jack wrote

commit log

Maybe we should tweak abc

Suggested by: jack

Please tweak abc

Requested by: jack

Abc doesn't work, fix it!

Reported by: jack

Here's a patch

Submitted by: jack

Standard text excerpts

- Update to 1.2.3
- Take maintainership
- Pass maintainership to submitter
- Drop maintainership
Add port foo/bar: <pkg-descr follows>
- Connect foo/bar to the build
- Bump portrevision
- Fix plist
- Add rc script


CategoryHowTo

CommitMessageFormat (last edited 2018-09-21T14:46:24+0000 by MateuszPiotrowski)