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

Updated Changelog Workflows (markdown)

Charlie 2020-07-19 16:29:23 +02:00
parent ad975220c0
commit 71fef04d7c
1 changed files with 17 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Changelog-Workflows.md

@ -1,6 +1,6 @@
## Introduction
This workflow outlines the processing steps taken by changelog maintainers to ensure that pull requests providing new functionality (i.e. Feature updates) are properly documented in order hat they may be adapted and published in the changelog for each release of QGIS
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.
## General Workflow
@ -21,7 +21,7 @@ This workflow outlines the processing steps taken by changelog maintainers to en
After 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 description doesn’t need to be perfect (it is understand that English may not be the mother tongue of many developers submitting features), however it is important that the functionality is well described. The English description will be tidied up the in step 6 below.
> Note that the English description doesn’t need to be perfect (it is understood that English may not be the mother tongue of many developers submitting features), however it is important that the functionality is well described. The English description will be edited for publication in step 6 below.
4) **Changelog** tagged entries which have been merged will be harvested to the Changelog site regularly. This is done using the ingestion tool as shown in the screenshot below:
@ -31,11 +31,11 @@ This workflow outlines the processing steps taken by changelog maintainers to en
https://github.com/qgis/QGIS/pulls?q=is%3Apr+is%3Aclosed+label%3AChangelog
First, the additional label on GitHub called ‘ChangelogHarvested’ will be applied to indicate that the entry has been harvested into.
First, the additional label on GitHub called ‘ChangelogHarvested’ will be applied to indicate that the entry has been harvested into the changelog content management site.
Next, the **Changelog** label will be removed. This will prevent the same PR being reharvested (by the tool outlined in step 4) in subsequent harvest runs on the changelog platform, whilst retaining the relevant label required to indicate the PR contains a changelog entry.
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 conventions that are described in the "Conventions for changelog entries" section below. The goal here is to massage the description etc. to fit into our changelog entry form:
6) The entry will then be edited on the changelog site in order to get it ready publication, with the goal of having the content ready prior to the publication date for the new 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 conventions that are described in the "Conventions for changelog entries" section below. The goal here is to massage the description etc. to fit into our changelog entry form:
![image](https://user-images.githubusercontent.com/178003/87296792-3437d400-c4ff-11ea-8754-1017e2397612.png)
@ -44,16 +44,18 @@ This workflow outlines the processing steps taken by changelog maintainers to en
![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.
8) After the changelog is finalised, changelog maintainers will notify Richard, who will then pull the changelog to the QGIS web site.
## More on tagging
We will add the **Changelog** tag when we want to ingest it so we will have 3 states basically:
We will add the **Changelog** tag when a PR tagged with the feature label has been reviewed and the description has been considered descriptive enough (of the functionality) that a suitable changelog entry may be developed from the available material. Once a PR tagged **Changelog** is merged, it will be considered ready for ingestion and once harvested, the **Changelog** tag will be replaced with the **ChangelogHarvested** tag to prevent duplication on the changelog site.
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
We will basically have a number of states which are outlined as follows:
1) Feature tag - PR description not reviewed or not suitable for inclusion in changelog
2) Feature tag + Changelog tag: PR Not Merged - feature description suitable for inclusion in changelog
3) Feature tag + Changelog tag: PR Merged - feature merged and ready for ingestion into changelog
4) Feature tag + ChangelogHarvested tag + PR merged - entry has been ingested into changelog
## Conventions for changelog entries
@ -63,9 +65,10 @@ 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:
- Not contain header tags such as ```<h1>``` as these will display on the changelog site as TOC links
- Media should be explicitly added to the entry (downloaded to local and uploaded with changelog tool)
- Have a single thumbnail icon
- The feature title should be unique
- Be categorised appropriately
- Language should generally be considered neutral
- Content should be articulate and concise
- Not contain header tags such as ```<h1>``` as these will display on the changelog site as TOC links
- Have a single thumbnail icon
- Media should be explicitly added to the entry (downloaded to local and uploaded with changelog tool)
- Language should generally be considered neutral, however developer comments or embellishments are permitted within reason