<div dir="ltr">Hi, and thanks for raising this Frank.<div><br></div><div>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.</div><div><br></div><div>We have set up a list of expected conventions for entries here:</div><div><br></div><div><a href="https://github.com/qgis/QGIS/wiki/Changelog-Workflows#conventions-for-changelog-entries">https://github.com/qgis/QGIS/wiki/Changelog-Workflows#conventions-for-changelog-entries</a><br></div><div><br></div><div>Feel free to contribute changes there as well.</div><div><br></div><div>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:</div><div><br></div><div><ul><li>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.</li><li>Tags - Some PRs use [tag-id]Title syntax to try and automatically tag pull requests, which need to be removed</li><li>PRs and Links - There are commonly a bunch of references </li><li>List and content formatting - Sometimes pushing from git does not end up with nicely rendered markdown, so we should try and fix it</li><li>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</li><li>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.</li></ul></div><div>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!<br></div><div><br></div><div>Regards</div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Mon, 4 Oct 2021 at 13:13, Frank Sokolic <<a href="mailto:sokolic@worldonline.co.za">sokolic@worldonline.co.za</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div>
<div>Hi changelog contributors,</div>
<div><br>
</div>
<div>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 ...".<br>
</div>
<div><br>
</div>
<div>Regards, Frank. <br>
</div>
<div><br>
</div>
<div><br>
</div>
<div>On 2021/09/26 11:51, Tim Sutton wrote:<br>
</div>
<blockquote type="cite">
<div dir="ltr">
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small">Hi
All<br clear="all">
</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small"><br>
</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small">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.</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small"><br>
</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small"><a href="https://changelog.qgis.org/en/qgis/version/3.22/" target="_blank">https://changelog.qgis.org/en/qgis/version/3.22/</a><br>
</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small"><br>
</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small">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 (<a href="mailto:charles@kartoza.com" target="_blank">charles@kartoza.com</a>).</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small"><br>
</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small">Thanks!</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small"><br>
</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small">Regards</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small"><br>
</div>
<div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small">Tim </div>
<div><br>
</div>
-- <br>
<div dir="ltr">
<div dir="ltr">
<div>
<div dir="ltr">
<div style="text-align:center">------------------------------------------------------------------------------------------</div>
<div style="text-align:center"><img src="https://mail.google.com/mail/u/0/?ui=2&ik=7ebbf93252&view=fimg&th=15a9e43c0bbf93ca&attid=0.1&disp=emb&realattid=9436e64174762963_0.1.1&attbid=ANGjdJ-WL_J24nvBiYidJ0V0xpdsYqRwswi5nq5oywcJEHC7twYVMrxG0y-GNPu_ahJthV8ktXwYuHoVm5DI2FrRAtPzelTRHrsE2wweR9uu8wT-zz2hNRqFwi4SorQ&sz=s0-l75-ft&ats=1488721675176&rm=15a9e43c0bbf93ca&atsh=1" style="color: rgb(0, 0, 0); font-family: Helvetica; font-size: 12px;"><br>
</div>
<div style="text-align:center">Tim Sutton</div>
<div style="text-align:center"><span style="text-align:start">Visit </span><a href="http://kartoza.com/" style="text-align:start" target="_blank">http://kartoza.com</a><span style="text-align:start"> to find out about open
source:</span><br style="text-align:start">
<span style="text-align:start"> * Desktop GIS
programming services</span><br style="text-align:start">
<span style="text-align:start"> * Geospatial web
development</span></div>
<div style="text-align:center"><span style="text-align:start">* GIS Training</span></div>
<div style="text-align:center"><span style="text-align:start">* Consulting Services</span></div>
<div style="text-align:center">
<div style="text-align:start">
<div style="text-align:center">Tim is a member of
the QGIS Project Steering Committee</div>
<div style="text-align:center">-------------------------------------------------------------------------------------------</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<br>
<fieldset></fieldset>
<pre>_______________________________________________
QGIS-Developer mailing list
<a href="mailto:QGIS-Developer@lists.osgeo.org" target="_blank">QGIS-Developer@lists.osgeo.org</a>
List info: <a href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" target="_blank">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a>
Unsubscribe: <a href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" target="_blank">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a>
</pre>
</blockquote>
<p><br>
</p>
</div>
_______________________________________________<br>
QGIS-Developer mailing list<br>
<a href="mailto:QGIS-Developer@lists.osgeo.org" target="_blank">QGIS-Developer@lists.osgeo.org</a><br>
List info: <a href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" rel="noreferrer" target="_blank">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a><br>
Unsubscribe: <a href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" rel="noreferrer" target="_blank">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a><br>
</blockquote></div>