Skip to content

Commit

Permalink
Update updating-an-existing-package.md
Browse files Browse the repository at this point in the history
Add notes to avoid using issue numbers in changelogs. Provide examples of how to correctly link to another issue in the getsolus repo.
  • Loading branch information
TraceyC77 authored Jan 6, 2024
1 parent 7248d07 commit 90bf785
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/packaging/updating-an-existing-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,14 +117,25 @@ git commit
There should be a meaningful summary line (which starts with the package name), a blank line, and then the rest of the commit message.

- 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.
- Include a changelog with a brief list of updates from the upstream release notes, with no links or issue numbers.
- There may also be a section for Solus specific work (e.g. rebuild against x / rework to remove dependency).
- Optional: A link to the upstream release notes page.
- Include your Test Plan.

`git commit` on [an initialized repository](prepare-for-packaging.md#initialize-git-hooks) will automatically open your editor with the correct template.
Note that lines starting with a `#` will be ignored by Git and do not need to be removed.

*Important*: Do not include issue numbers in changelogs. This will incorrectly link your issue to another one in our repository. Ex:
```
- #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:

```
Fixes getsolus/packages#issuenumber
```

Here is an example in our standard format:

```
Expand Down

0 comments on commit 90bf785

Please sign in to comment.