user_ChangeLogImpl.xml

Timestamp:

Aug 19, 2021 8:57:00 AM (3 years ago)

Author:

vboxsync

Message:

Changelog: Added some rules for adding changelog entries so that we don't have to do manual touch-ups over and over again.

File:

trunk/doc/manual/user_ChangeLogImpl.xml

-              r86546
+              r90738
 also try to describe the user impact, not the technical details, and only use
 technical terms if no non-technical ones are clear enough.
+Rules for adding a changelog entry to make them look more uniform:
+. Begin the entry with an UPPERCASE letter, e.g. "Foo: Fixed" vs. "Foo: fixed"
+. Use the past form of something, e.g. "Fixed ..." vs. "Fix ..."
+. No dot (.) after the entry, e.g. "<para>Foo: Bar</para>" vs. "<para>Foo: Bar.</para>"
+    Full example:
+        <listitem>
+          <para>Foo: Fixed something really important</para>
+        </listitem>
 -->
 <chapter>

Note: See TracChangeset for help on using the changeset viewer.