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:50:31 +02:00
parent e23684980d
commit 7226aface9
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Changelog-Workflows.md

@ -73,10 +73,13 @@ 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 following list outlines some basic guidelines for ensuring the entry content is of the required standards:
- The feature title should be unique - 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.
- Be categorised appropriately - 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 - 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.
- Not contain header tags such as ```<h1>``` as these will display on the changelog site as TOC links - Git/ GitHub specific references such as 'This PR adds' introductions should be modified to 'Functionality was introduced to' or 'We have added'.
- Have a single thumbnail icon - References to issues and pull requests, such as `Fixes #123456` should ideally be modified to full descriptive links, e.g. ```This addresses the limitations identified in <a href="https://github.com/qgis/QGIS/issues/123456">issue 123456</a>.```
- Media should be explicitly added to the entry (downloaded to local and uploaded with changelog tool) - Entry content should not contain any header tags such as ```<h1>```, ```<h2>``` or ```<h4>``` etc. as these will display on the changelog site as links within the TOC (table of contents).
- Language should generally be considered neutral, however developer comments or embellishments are permitted within reason - Each entry should have a single primary thumbnail icon. Additional media elements should be embedded in the content body.
- Media should be explicitly added to the entry (downloaded to local and uploaded with the changelog tool).
- Language should generally be considered neutral, however developer comments or embellishments are permitted within reason. American English is the preferred standard for spelling and grammar.
- References to oneself should be changed to group pronouns (i.e. 'I' becomes 'we')