Skip to content
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.

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

new package: Update example to subject: verb version #496

Merged
merged 5 commits into from
Mar 1, 2024
Merged
Changes from 1 commit
Commits
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
15 changes: 15 additions & 0 deletions docs/packaging/updating-an-existing-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
- #123 fixed a thing
```

If you want to intentionally link to another issue in this repository, the right way is to use our repo name. Ex:

Check warning on line 134 in docs/packaging/updating-an-existing-package.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (repo)

```
Fixes getsolus/packages#issuenumber
Expand Down Expand Up @@ -167,6 +167,21 @@
- [ ] Package was built and tested against unstable
```

### Other commit message format examples
EbonJaeger marked this conversation as resolved.
Show resolved Hide resolved

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:

Check warning on line 172 in docs/packaging/updating-an-existing-package.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (shortlogs)

- Add the `homepage` metadata key:
- `package: Add homepage`
- Fix a packaging issue (including adding a patch to fix the package)
- `package: Fix (...)`
- 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`
EbonJaeger marked this conversation as resolved.
Show resolved Hide resolved

`[NFC]` is an abbreviation adopted from the clang compiler suite, which expands to "Non Functional Change".
EbonJaeger marked this conversation as resolved.
Show resolved Hide resolved

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.

Check warning on line 183 in docs/packaging/updating-an-existing-package.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (shortlog)

Check warning on line 183 in docs/packaging/updating-an-existing-package.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (shortlogs)
EbonJaeger marked this conversation as resolved.
Show resolved Hide resolved

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).

Next, you'll [submit a pull request for review](submitting-a-pull-request.md).