rspec/rules/S3423/xml/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

68 lines
1.3 KiB
Plaintext

== Why is this an issue?
The POM Code Convention is the Maven project's internal recommendation for POM element ordering. It calls for listing modifiers in the following order:
. <modelVersion/>
. <parent/>
. <groupId/>
. <artifactId/>
. <version/>
. <packaging/>
. <name/>
. <description/>
. <url/>
. <inceptionYear/>
. <organization/>
. <licenses/>
. <developers/>
. <contributors/>
. <mailingLists/>
. <prerequisites/>
. <modules/>
. <scm/>
. <issueManagement/>
. <ciManagement/>
. <distributionManagement/>
. <properties/>
. <dependencyManagement/>
. <dependencies/>
. <repositories/>
. <pluginRepositories/>
. <build/>
. <reporting/>
. <profiles/>
Not following this convention has no technical impact, but will reduce the pom's readability because most developers are used to the standard order.
== Resources
* https://maven.apache.org/developers/conventions/code.html#POM_Code_Convention[POM Code Convention]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Reorder the elements of this pom to match the recommended order.
=== Highlighting
"project" part of <project> tag
'''
== Comments And Links
(visible only on this page)
=== on 30 Nov 2015, 14:18:54 Michael Gumowski wrote:
LGTM [~ann.campbell.2]!
endif::env-github,rspecator-view[]