Uploaded image for project: 'Log4j 2'
  1. Log4j 2
  2. LOG4J2-3651

2.20.0 release notes change pattern confused ("for")

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Open
    • Trivial
    • Resolution: Unresolved
    • 2.20.0
    • None
    • Documentation
    • None

    Description

      The Log4j 2.20.0 release notes contain numerous items in the form:

      Description (for ID by authors)

      In most cases, this format makes sense, since the change was performed for solving the issue reported in the ticket mentioned. For example, "Removes internal field that leaked into public API. (for LOG4J2-3615 by Piotr P. Karwasz)" indicates that a field was removed for solving LOG4J2-3615.

      For changes which are not motivated by a report though, the items refer to a merge request instead of a ticket, as in the following example:
      Simplify site generation (for 1166 by Volkan Yazıcı)

      These items are confusing since the link brings to a description of the change rather than to a description of the problem.
      Items which refer to merge requests should use an appropriate pattern, such as:

      Description (via ID by authors)

       

      By the way:

      • "Removes internal field that leaked into public API" should not be in the Added section.
      • Version 2.20.0 is still listed as unreleased in this ITS.

      Attachments

        Activity

          People

            Unassigned Unassigned
            Chealer Philippe Cloutier
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: