[
https://issues.apache.org/jira/browse/MNGSITE-310?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16047888#comment-16047888
]
Franz van Betteraey commented on MNGSITE-310:
---------------------------------------------
A recommendation would just make things easier. That is a strong motivation in
my point of view. I do not see any motivation/benefit so far to not have a
recommendation.
And it should just be a recommendation, of course team/organizations can use
there own structure.
By the way quote from the dev page
{quote}
The consequence of this vote is that the Maven project descriptor is no more
considered as the reference for the ordering.
{quote}
Ignoring the dev page would mean that the [Maven project descriptor
reference|https://maven.apache.org/ref/3.5.0/maven-model/maven.html]
could/should still be considered to be the reference for ordering. Although the
schema does not enforce any element order this is probably that what people
would use (and used) if for (if I understand the quote right).
For me the concrete order is not that relevant. I just like to have a
recommendation that I can use and promote in my team. I also like the tool
support mentioned above - which probably would not exist in case of no
recommendation.
[~snicoll]: I understand your point (and probably fears). If it makes sense to
point out the developer context of the recommendation in the tools that support
it, then this might also be sufficient. But it would be a pity if the tool
support would be restricted or abolished. Having a recommendation is not that
bad.
> 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)
