[Qgis-psc] Updates to the way changelog entries are managed

Nyall Dawson nyall.dawson at gmail.com
Mon Jul 6 17:19:52 PDT 2020


Hi Tim,

Thanks for your hard work here!

> 2) Tasked Charles to read each PR that has a ‘Feature’ label as it comes in and in the comments section, nudge the author if the description is not clear / well described. 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. Note that the English doesn’t need to be perfect (we are understanding  that English may not be your mother toungue), 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, Charles will add the ‘Changelog’ tag to it.

To clarify -- we DON'T manually add the changelog tag to anything?
Just the feature tag is sufficient?

One potential reservation I have with this process is that it means
that PR descriptions need to be user-focused, rather then developer
focused. I think this is a bit backwards -- for review purposes it's
better to focus the PR comment on the technical details rather than
just using the "glossy overview" that we want for the changelog.

Could we do something fancy like add a section in the PR template for
"changelog entry" and only harvest this part for the changelog?

Nyall





>
> 4) Once the PR is merged, we will regularly Harvest the ‘Changelog tagged entries to the Changelog site.
>
> 5)  We have added an additional tag on GitHub called ‘ChangelogHarvested’ which will be applied after and entry is harvested, and the Changelog tag then removed (and should bot be readied to avoid duplicates being pulled in).
>
> 6) The entry will then be tidied up on the changelog site ready for the release. Additional volunteers (e.g. Toto, Frank) who have helped in the past are warmly invited to help improve the clarity and consistency of the entries on the changelog site.
>
> 7) When the release comes near we just need the paid bug fixing entries added (usually managed by Andreas Neumann) and then Richard can pull the changelog to the QGIS web site.
>
>
> I have started the Changelog for 3.16 here: https://changelog.qgis.org/en/qgis/version/3.16/
>
>
> I hope that works for everyone, and that we get smoother changelog production in the future!
>
> Regards
>
> Tim
>
>
>
>>
>
>
>
>
>
>
>
>
>
>
> Tim Sutton
>
> Co-founder: Kartoza
> Honorary PSC Member and Ex-Project chair: QGIS.org
>
> Visit http://kartoza.com to find out about open source:
>
> Desktop GIS programming services
> Geospatial web development
> GIS Training
> Consulting Services
>
> Skype: timlinux
> IRC: timlinux on #qgis at freenode.net
>
> I'd love to connect. Here's my calendar link to make finding time easy.
>
> _______________________________________________
> Qgis-psc mailing list
> Qgis-psc at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/qgis-psc


More information about the Qgis-psc mailing list