From 90bf785729e1810020c47673a311482b14d19b25 Mon Sep 17 00:00:00 2001 From: Tracey Date: Sat, 6 Jan 2024 15:17:45 -0600 Subject: [PATCH] Update updating-an-existing-package.md Add notes to avoid using issue numbers in changelogs. Provide examples of how to correctly link to another issue in the getsolus repo. --- docs/packaging/updating-an-existing-package.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/packaging/updating-an-existing-package.md b/docs/packaging/updating-an-existing-package.md index a1deca0ea..6a11be571 100644 --- a/docs/packaging/updating-an-existing-package.md +++ b/docs/packaging/updating-an-existing-package.md @@ -117,7 +117,7 @@ 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. @@ -125,6 +125,17 @@ There should be a meaningful summary line (which starts with the package name), `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: ```