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

Created Changelog Workflows (markdown)

Tim Sutton 2020-07-13 11:48:40 +01:00
parent 16878ad21d
commit 5f241be149
1 changed files with 69 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
Changelog-Workflows.md Normal file

@ -0,0 +1,69 @@
## Introduction
blah blah
## General Workflow
1) The changelog maintainer (currently GitHub user: zacharlie) is added to the ‘Community’ GitHub group which has triage rights
![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:
https://github.com/qgis/QGIS/pulls?q=is%3Aopen+is%3Apr+label%3AFeature
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. Once the **Changelog** tag has been added, the PR maintainers should feel free to merge the PR if they are happy with it.
Note that the English doesn’t need to be perfect (we are understanding that English may not be your mother tongue), the important thing is that the functionality is well described - we will tidy up the English in step 6 below.
3) Once the PR description is good, the changelog maintainer will add the ‘Changelog’ tag to it as per the example below.
![image](https://user-images.githubusercontent.com/178003/87294981-701d6a00-c4fc-11ea-80d9-9411a7070be2.png)
4) Once the PR is merged, we will regularly Harvest the ‘Changelog tagged entries to the Changelog site. This is done using the ingestion tool as shown in the screenshot below:
![image](https://user-images.githubusercontent.com/178003/87295427-0fdaf800-c4fd-11ea-9d8e-a30dce3f9fcd.png)
5) After the closed Changelog PRs have been harvested, we will go here:
https://github.com/qgis/QGIS/pulls?q=is%3Apr+is%3Aclosed+label%3AChangelog
First we will apply the additional tag on GitHub called ‘ChangelogHarvested’.
Next remove the Changelog tag.
This will prevent the same PR being reharvested in subsequent harvest runs on the changelog platform.
6) The entry will then be tidied up on the changelog site ready for the release. Additional volunteers from the changelog maintainers team will help improve the clarity and consistency of the entries on the changelog site. The entry should follow the contensions that are described in the "Conventions for changelog entries" section below.
7) When the release comes near we need the paid bug fixing entries added under 'Notable fixes'. This is managed by Andreas Neumann.
![image](https://user-images.githubusercontent.com/178003/87296304-76ace100-c4fe-11ea-8eae-d73a59471e05.png)
8) After the changelog is finalised, notify Richard who will then pull the changelog to the QGIS web site.
## More on tagging
We will add the tag when we want to ingest it so we will have 3 states basically:
1) Feature tag - not ready for ingestion in Changelog
2) Feature tag + Changelog tag + PR Merged - ready for ingestion
3) Feature tag + ChangelogHarvested tag + PR merged - entry has been ingested
## Conventions for changelog entries