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-08 13:46:04 +02:00
parent fe8870a5b6
commit 3ab20f4f2c
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Changelog-Workflows.md

@ -83,6 +83,7 @@ The following list outlines some basic guidelines for ensuring the entry content
- Special characters should be avoided. Where relevant, move special characters like parenthesis and extraneous description elements from the entry title and into the description body. - Special characters should be avoided. Where relevant, move special characters like parenthesis and extraneous description elements from the entry title and into the description body.
- Media should be explicitly added to the entry (downloaded to local and uploaded with the changelog tool). - 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. - 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.
- In some instances, especially with complex functionality, additional details or media on the feature may be discussed within the comments of the original PR on github, which should be reviewed where relevant and included in the changelog entry.
- References to oneself should be changed to group pronouns (i.e. 'I' becomes 'we') - References to oneself should be changed to group pronouns (i.e. 'I' becomes 'we')
- Each developer tends to have different styles and standards for the structure and format of the entry content. Where possible, we should endeavour to keep things as consistent with the other entries as possible. - Each developer tends to have different styles and standards for the structure and format of the entry content. Where possible, we should endeavour to keep things as consistent with the other entries as possible.