[jira] [Commented] (MNGSITE-310) general recommendation for the element order in the POM

["Stephane Nicoll (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/MNGSITE-310?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16047798#comment-16047798 ] 

Stephane Nicoll commented on MNGSITE-310:
-----------------------------------------

Claiming it is established based on what seems to be a misunderstanding is not really an argument. At the end of the day, this page is a Maven dev page and was never meant to be a public recommendation. If we didn't, I could only assume there is a good reason for that.

IMO (and at the current state of the project), providing an official recommendation for the entire POM file will be very hard to justify. I think some element can definitely be described (like having the parent relatively at the top) but such a well-defined order is a team/organization/project specific matter IMO

> general recommendation for the element order in the POM
> -------------------------------------------------------
>
>                 Key: MNGSITE-310
>                 URL: https://issues.apache.org/jira/browse/MNGSITE-310
>             Project: Maven Project Web Site
>          Issue Type: Improvement
>            Reporter: Franz van Betteraey
>            Priority: Minor
>              Labels: convention, pom
>
> A [convention|https://maven.apache.org/developers/conventions/code.html#POM_Code_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|https://maven.apache.org/maven-conventions.html] or [POM reference |https://maven.apache.org/pom.html] 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|https://jira.sonarsource.com/browse/RSPEC-3423]) and to support this convention ([Tidy Maven plugin|http://www.mojohaus.org/tidy-maven-plugin/]). The Convention is thus already established.
> 	



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)