<div dir="ltr">Lubos,<div><br></div><div><div><div dir="ltr" data-smartmail="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div>+1 to past simple tense. +1 to updating our changelog docs.</div><div><br></div><div>Thank you for raising this issue.</div><div><br></div><div>David<br></div></div></div></div></div></div></div></div><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Mon, Feb 17, 2020 at 10:55 AM Lubos Mjachky <<a href="mailto:lmjachky@redhat.com" target="_blank">lmjachky@redhat.com</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 dir="ltr">Dear colleagues,<div><br></div><div>I have recently noticed that our changelog often contains non-uniform messages informing about particular changes.</div><div><br></div><div>For instance, take a look at the changelogs in pulp_container (<a href="https://pulp-container.readthedocs.io/en/latest/changes.html" target="_blank">https://pulp-container.readthedocs.io/en/latest/changes.html</a>) or pulpcore (<a href="https://docs.pulpproject.org/en/master/nightly/changes.html" target="_blank">https://docs.pulpproject.org/en/master/nightly/changes.html</a>):</div>1. As a user I can manage images in OCI format.<br>2. Let users fetch the list of all distributed repositories via the _catalog endpoint.<br>3. Adds ability to build OCI images from Containerfiles. <br>4. Added v2s2 to v2s1 converter.<div>5. Allow administrators to add a signing service.</div><div>6. Files stored on S3 and Azure now download with the correct filename.<br><div><br></div><div>As you can see, we are using there random tenses and sentence structures. I am in favor of establishing one feasible convention for all changelog messages. We should strive to use only one tense, e.g. past simple. Then, the messages would rather look like this [0]:</div><div>1. Removed the filter for the field 'digest'.</div><div>2. Added support for mirror mode.</div><div><br></div><div>Please feel free to support this idea or raise any concerns. If we reach a viable consensus I will create a PR which will add a note about acceptable changelog messages to the corresponding section here <a href="https://docs.pulpproject.org/en/master/nightly/contributing/git.html#changelog-update" target="_blank">https://docs.pulpproject.org/en/master/nightly/contributing/git.html#changelog-update</a>. Thank you in advance.</div><div><br></div><div>[0] <a href="https://keepachangelog.com/en/1.0.0/#how" target="_blank">https://keepachangelog.com/en/1.0.0/#how</a></div></div></div>
_______________________________________________<br>
Pulp-dev mailing list<br>
<a href="mailto:Pulp-dev@redhat.com" target="_blank">Pulp-dev@redhat.com</a><br>
<a href="https://www.redhat.com/mailman/listinfo/pulp-dev" rel="noreferrer" target="_blank">https://www.redhat.com/mailman/listinfo/pulp-dev</a><br>
</blockquote></div>