[QGIS-Developer] Changelog Time for 3.22

[Charles Dixon-Paver]

Hi, and thanks for raising this Frank.

I've noticed a bunch of the entries have just been tagged with a category
rather than undergoing a full edit from the PR text, which we need to try
to make more "user friendly" and less "developer-centric". The technical
details of each PR are still available on github and I think the changelog
targets a different audience.

We have set up a list of expected conventions for entries here:

https://github.com/qgis/QGIS/wiki/Changelog-Workflows#conventions-for-changelog-entries

Feel free to contribute changes there as well.

Whilst I think the contextual and writing style stuff is not of critical
concern, there are a couple major red flags we need to try eliminate before
publication, including:


   - Headers - The records should not contain any headers (in HTMl or
   markdown) in the content section as this interferes with the ToC generated
   in the Visual Changelog. This is critical because I think the PR template
   or convention includes a description header etc.
   - Tags - Some PRs use [tag-id]Title syntax to try and automatically tag
   pull requests, which need to be removed
   - PRs and Links - There are commonly a bunch of references
   - List and content formatting - Sometimes pushing from git does not end
   up with nicely rendered markdown, so we should try and fix it
   - Entry title - Often a developer will write a sentence for describing
   the functionality, which is certainly helpful for the review process. For
   changelogs we can move this to the description and use a simple 3 - 8 word
   (there's no real rule) title so that it's rendered nicely and without too
   much wrapping in the ToC
   - Extraneous details - I think it's better to be concise and we can
   remove some content from a lot of the entries. Many PRs justify what, why,
   and how some functionality was developed and introduced, whereas for the
   changelog we just need to know what it does.

I would ask that contributors rather refrain from simply tagging entries
until they have gone through some form of editing, as it makes it difficult
to track what has been reviewed fully and what has not - I prefer to work
through the entries methodically and if need be I am happy run through all
the entries and simply tag them before the final release date. Certainly
review the entries available in the general section, and feel free to edit
them if you would like, but don't move them into a category until they're
"publishing-ready". Also, anybody can feel free to ping me if they see a
feature missing!

Regards

On Mon, 4 Oct 2021 at 13:13, Frank Sokolic <sokolic at worldonline.co.za>
wrote:

> Hi changelog contributors,
>
> I've been reading through the changelog entries, checking grammar and
> readability, and noticed that many entries refer to PR. Given that the
> target audience of the changelog is more than just developers /
> contributors, would anybody be unhappy if I changed PR to something like
> "feature" or "function"? So an entry that currently reads "This PR allows
> users to ..." would change to "This feature allows users to ...".
>
> Regards, Frank.
>
>
> On 2021/09/26 11:51, Tim Sutton wrote:
>
> Hi All
>
> Since we are in feature freeze now,  can I ask you all (especially
> contributors of new features to) please clean up your entries in the
> changelog - lots of them need tidy ups to be presentable for the changelog.
>
> https://changelog.qgis.org/en/qgis/version/3.22/
>
> Even if you didn't develop features, it would be great if you are able to
> contribute improvements to make the changelog readable. If you need any
> help, contact myself or Charles (charles at kartoza.com).
>
> Thanks!
>
> Regards
>
> Tim
>
> --
>
> ------------------------------------------------------------------------------------------
>
> Tim Sutton
> Visit http://kartoza.com to find out about open source:
>  * Desktop GIS programming services
>  * Geospatial web development
> * GIS Training
> * Consulting Services
> Tim is a member of the QGIS Project Steering Committee
>
> -------------------------------------------------------------------------------------------
>
> _______________________________________________
> QGIS-Developer mailing listQGIS-Developer at lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
>
>
> _______________________________________________
> QGIS-Developer mailing list
> QGIS-Developer at lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20211004/7bebf404/attachment-0001.html>