Franz van Betteraey created MNGSITE-310:
-------------------------------------------
Summary: 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
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)
