Skip to content

Commit

Permalink
updating-package: Attempt to address review notes
Browse files Browse the repository at this point in the history
Signed-off-by: Rune Morling <ermo@serpentos.com>
  • Loading branch information
ermo committed Mar 1, 2024
1 parent 20f2b54 commit d6d415c
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions docs/packaging/updating-an-existing-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,17 @@ If all looks well, commit your changes.
git commit
```

### Commit message format for updated / bumped packages
## Commit message format

There should be a meaningful summary line (which starts with the package name), a blank line, and then the rest of the commit message.
With the switch to a single large package git repository, having a regular, easy-to-read standardized commit message format helps enable quick and efficient "at-a-glance" parsing of git commit messages for packagers and Staff alike.

Each commit message should consist of a meaningful summary line (which starts with the package name), a blank line, and then the rest of the commit message body.

Note that `[NFC]` (listed in an example below) is an abbreviation for "No Functional Change".

### Package update

The following guidelines apply to the commit message body:

- Bullet point lists should start with a dash.
- Include a changelog with a brief list of updates from the upstream release notes, with no links or issue numbers.
Expand Down Expand Up @@ -169,7 +177,7 @@ Full release notes:

### Other commit message format examples

In the cases where you are not updating a package to a new version, but simply applying a patch or fixing an existing version, the following commit message shortlogs are considered suitable:
In the cases where you are not updating a package to a new version, but simply applying a patch or fixing an existing version, the following commit messages are considered suitable:

- Add the `homepage` metadata key:
- `package: Add homepage`
Expand All @@ -178,9 +186,7 @@ In the cases where you are not updating a package to a new version, but simply a
- Updating a README, monitoring.yml file or other stuff that does not directly _change_ the package, meaning the package release number didn't need a bump:
- `package: [NFC] Add README.md and monitoring.yml`

`[NFC]` is an abbreviation adopted from the clang compiler suite, which expands to "Non Functional Change".

The overall reasoning for the git shortlog formats shown above is to enable quick and efficient "at-a-glance" parsing of git shortlogs for Solus Staff.
As stated previously, `[NFC]` is an abbreviation of "No Functional Change".

For more information on suitable commit messages, please check the [tooling central documentation](https://github.com/solus-project/tooling-central/blob/master/README.rst#using-git).

Expand Down

0 comments on commit d6d415c

Please sign in to comment.