sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-06-27 00:02:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated Changelog Workflows (markdown)

Tim Sutton 2022-02-14 00:54:44 +00:00
parent 6645734259
commit 3842de1633
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Changelog-Workflows.md

@ -2,13 +2,19 @@
This workflow outlines the processing steps taken by changelog maintainers to ensure that pull requests providing new functionality (feature updates) are properly documented in order that they may be adapted and published in a format optimised for the user facing changelog that is published with each new release of QGIS. Here is an overview of the process:
![QGIS-Changelog-Workflow](https://user-images.githubusercontent.com/178003/91617367-cb59cd80-e97f-11ea-9928-8d1a50da6b49.png)
Diagrams.net source file for above image: ([QGIS-Changelog-Workflow.zip](https://github.com/qgis/QGIS/files/5144291/QGIS-Changelog-Workflow.zip)).
![QGIS-Changelog-Workflow drawio](https://user-images.githubusercontent.com/178003/153783290-0e24d94d-c351-4cbc-84e7-8134a77e37a8.png)
Diagrams.net source file for above image: ([QGIS-Changelog-Workflow.zip](https://github.com/qgis/QGIS/files/8057091/QGIS-Changelog-Workflow.zip)).
[![Changelog walk through by Charles Dixon-Paver](https://img.youtube.com/vi/iC36BN0SWTE/0.jpg)](https://www.youtube.com/watch?v=iC36BN0SWTE)
Click the image above to play a YouTube video containing a walk through by Charles Dixon-Paver (scrub forward to around 3 minutes 30 seconds for the actual walk through to start).
Click the image above to play a YouTube video containing a walk-through by Charles Dixon-Paver (scrub forward to around 3 minutes 30 seconds for the actual walk-through to start). **Note** the diagram above was updated slightly and may differ from the one shown in the above video.
## General Workflow
@ -17,9 +23,9 @@ Click the image above to play a YouTube video containing a walk through by Charl
![image](https://user-images.githubusercontent.com/178003/87294309-765f1680-c4fb-11ea-8268-9fe0555a1c04.png)
2) The changelog maintainer will read each Pull Request (PR) that has a **Feature** label as it comes in as per the following URL:
2) The changelog maintainer will read each Pull Request (PR) that has a **Changelog Candidate** label as it comes in as per the following URL:
https://github.com/qgis/QGIS/pulls?q=is%3Aopen+is%3Apr+label%3AFeature
https://github.com/qgis/QGIS/pulls?q=isopen+is%3Apr+label%3AChangelog
In the comments section, they will make a comment to the author if the feature is not clear / well described. We would be grateful if the PR gatekeepers could hold back on merging Feature PR’s that have issues, do not have a **Changelog** tag applied.