sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-08-11 00:03:56 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated Changelog Workflows (markdown)

Charlie 2020-10-07 22:51:13 +02:00
parent 7226aface9
commit 746820feae
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Changelog-Workflows.md

@ -73,7 +73,7 @@ The entries will therefore need to comply with the associated stylesheets and co
The following list outlines some basic guidelines for ensuring the entry content is of the required standards:
- The feature title should be unique. Pull requests often use "tags" to automatically manage elements in the workflow such as adding the [Feature] label to the element title. All such elements should be removed, and the title should properly convey the new functionality introduced.
- The feature title should be unique. Pull requests often use "tags" to automatically manage elements in the workflow such as adding the **[Feature]** label to the element title. All such elements should be removed, and the title should properly convey the new functionality introduced.
- Each entry should be categorised appropriately. By default, all newly imported entries will be included in the "General" category, however only entries that truly belong in the general category should be categorised as general by the time of publication.
- Content should be articulate and concise. Details from the pull request relating to developer specific content or items specifically for the documentation team can be removed. Some information on the feature utilisation is suitable, however it should not be verbose.
- Git/ GitHub specific references such as 'This PR adds' introductions should be modified to 'Functionality was introduced to' or 'We have added'.