Uploaded image for project: 'Maven Project Web Site'
  1. Maven Project Web Site
  2. MNGSITE-310

general recommendation for the element order in the POM

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Minor
    • Resolution: Won't Fix

    Description

      A convention for the element order in POM files is recommended for Maven developer and contributor but not for the general usage of Maven. I think it would be useful to recommend the element order also for general usage. A common order would

      • give an answer to the question of the order for all who ask themselves this question
      • help to easily cope with the content of pom files (even in unknown projects)

      A good place for the recommendation would be the Maven conventions or POM reference document.

      The background for this request is a discussion on twitter:
      https://twitter.com/FrVaBe/status/870263530473369601
      https://twitter.com/snicoll/status/874231018957545472

      A possible argument against such a convention would probably be, that projects that used another element order would be suddenly considered as "wrong" ordered.

      But I think that everyone that wondered about how to order the elements has probably found the developer conventions and used theses as an appropriate convention. There are even tools to check this convention (SonarQube) and to support this convention (Tidy Maven plugin). The Convention is thus already established.

      Attachments

        Activity

          People

            Unassigned Unassigned
            frvabe Franz van Betteraey
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: