elharo commented on code in PR #642: URL: https://github.com/apache/maven-site/pull/642#discussion_r1916297188
########## content/markdown/guides/mini/guide-naming-conventions.md: ########## @@ -0,0 +1,126 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +<head> + <title>Naming conventions of Maven coordinates (groupId, artifactId, and version)</title> +</head> + +# Naming convention of Maven coordinates + +So that Maven can identify and utilise any artifact (e.g. a `.jar` file), this artifact must be identifiable through a +unique combination of three identifiers. +This combination is called the "[Maven coordinates][4]". +Maven coordinates consist of a project identifier named `groupId`, an artifact +identifier named `artifactId`, and the version identifier named `version`. + +This document defines the naming conventions of Maven coordinates. + +You should follow this convention whenever you create a new artifact. + +## Project identifier + +The `groupId` uniquely identifies the project across all projects. +Each `groupId` should follow [Java's package name rules][1]. +This means it starts with a reversed domain name you control. + +Examples + +``` +org.apache.maven +org.apache.commons +``` + +There are many legacy projects that do not follow this convention and instead use single word group IDs. +However, it will be difficult to get a new single word group ID approved for inclusion in the Maven Central repository. + +You can create as many subgroups as you want. +A good way to determine the granularity of the `groupId` is to use the project structure. +If the current project contains multiple subprojects, each subproject should append a new identifier to the parent's +`groupId`. + +Example + +``` +// Parent +org.apache.maven + +// Subprojects +org.apache.maven.plugins +org.apache.maven.reporting +``` + +## Artifact identifier + +The `artifactId` is the name of the artifact and therefore should describe the artifacts content. +The identifiers should only consist of *lowercase* letters, digits, and hyphens only. + +Examples + +``` +commons-math +maven-clean-plugin +``` + +## Version identifier + +The `version` should follow the rules of [Semantic Versioning][2]. Review Comment: Semantic Versioning 1.0 Maven does not understand or follow semver 2.0. Al;so, perhaps weaken this to make it clear this is advisory and not mandatory. E.g. "Preferably the version" or "We recommend that the version follow" ########## content/markdown/guides/mini/guide-naming-conventions.md: ########## @@ -0,0 +1,126 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +<head> + <title>Naming conventions of Maven coordinates (groupId, artifactId, and version)</title> +</head> + +# Naming convention of Maven coordinates + +So that Maven can identify and utilise any artifact (e.g. a `.jar` file), this artifact must be identifiable through a +unique combination of three identifiers. +This combination is called the "[Maven coordinates][4]". +Maven coordinates consist of a project identifier named `groupId`, an artifact +identifier named `artifactId`, and the version identifier named `version`. + +This document defines the naming conventions of Maven coordinates. + +You should follow this convention whenever you create a new artifact. + +## Project identifier + +The `groupId` uniquely identifies the project across all projects. +Each `groupId` should follow [Java's package name rules][1]. +This means it starts with a reversed domain name you control. + +Examples + +``` +org.apache.maven +org.apache.commons +``` + +There are many legacy projects that do not follow this convention and instead use single word group IDs. +However, it will be difficult to get a new single word group ID approved for inclusion in the Maven Central repository. + +You can create as many subgroups as you want. +A good way to determine the granularity of the `groupId` is to use the project structure. +If the current project contains multiple subprojects, each subproject should append a new identifier to the parent's +`groupId`. + +Example + +``` +// Parent +org.apache.maven + +// Subprojects +org.apache.maven.plugins +org.apache.maven.reporting +``` + +## Artifact identifier + +The `artifactId` is the name of the artifact and therefore should describe the artifacts content. +The identifiers should only consist of *lowercase* letters, digits, and hyphens only. + +Examples + +``` +commons-math +maven-clean-plugin +``` + +## Version identifier + +The `version` should follow the rules of [Semantic Versioning][2]. +It should start with the major version, followed by the minor version and the patch version. +All three are numeric, separated by a dot. + +Examples + +``` +1.0.0 +2.3.2 +3.5.42 +``` + +You can add labels for pre-releases or build metadata after the patch version. +Avoid using dates in those labels, because they are usually associated with unstable versions (see below). + +Examples + +``` +// Pre-releases +1.0.0-beta +1.0.0-M1 +1.0.0-rc2 + +// Build metadata +1.2.3+dfc0c87 +2.3.4+15433 +``` + +### Unstable versions (SNAPSHOT) + +The "latest" code on a development branch might probably change. +Maybe it's even unstable and not ready for use. Review Comment: delete even ########## content/markdown/guides/mini/guide-naming-conventions.md: ########## @@ -0,0 +1,126 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +<head> + <title>Naming conventions of Maven coordinates (groupId, artifactId, and version)</title> +</head> + +# Naming convention of Maven coordinates + +So that Maven can identify and utilise any artifact (e.g. a `.jar` file), this artifact must be identifiable through a +unique combination of three identifiers. +This combination is called the "[Maven coordinates][4]". +Maven coordinates consist of a project identifier named `groupId`, an artifact +identifier named `artifactId`, and the version identifier named `version`. + +This document defines the naming conventions of Maven coordinates. + +You should follow this convention whenever you create a new artifact. + +## Project identifier + +The `groupId` uniquely identifies the project across all projects. +Each `groupId` should follow [Java's package name rules][1]. +This means it starts with a reversed domain name you control. + +Examples + +``` +org.apache.maven +org.apache.commons +``` + +There are many legacy projects that do not follow this convention and instead use single word group IDs. +However, it will be difficult to get a new single word group ID approved for inclusion in the Maven Central repository. + +You can create as many subgroups as you want. +A good way to determine the granularity of the `groupId` is to use the project structure. +If the current project contains multiple subprojects, each subproject should append a new identifier to the parent's +`groupId`. + +Example + +``` +// Parent +org.apache.maven + +// Subprojects +org.apache.maven.plugins +org.apache.maven.reporting +``` + +## Artifact identifier + +The `artifactId` is the name of the artifact and therefore should describe the artifacts content. +The identifiers should only consist of *lowercase* letters, digits, and hyphens only. + +Examples + +``` +commons-math +maven-clean-plugin +``` + +## Version identifier + +The `version` should follow the rules of [Semantic Versioning][2]. +It should start with the major version, followed by the minor version and the patch version. +All three are numeric, separated by a dot. + +Examples + +``` +1.0.0 +2.3.2 +3.5.42 +``` + +You can add labels for pre-releases or build metadata after the patch version. +Avoid using dates in those labels, because they are usually associated with unstable versions (see below). + +Examples + +``` +// Pre-releases +1.0.0-beta +1.0.0-M1 +1.0.0-rc2 + +// Build metadata +1.2.3+dfc0c87 +2.3.4+15433 +``` + +### Unstable versions (SNAPSHOT) + +The "latest" code on a development branch might probably change. Review Comment: delete probably as it's implicit in "might" ########## content/markdown/guides/mini/guide-naming-conventions.md: ########## @@ -0,0 +1,126 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +<head> + <title>Naming conventions of Maven coordinates (groupId, artifactId, and version)</title> +</head> + +# Naming convention of Maven coordinates + +So that Maven can identify and utilise any artifact (e.g. a `.jar` file), this artifact must be identifiable through a +unique combination of three identifiers. +This combination is called the "[Maven coordinates][4]". +Maven coordinates consist of a project identifier named `groupId`, an artifact +identifier named `artifactId`, and the version identifier named `version`. + +This document defines the naming conventions of Maven coordinates. + +You should follow this convention whenever you create a new artifact. + +## Project identifier + +The `groupId` uniquely identifies the project across all projects. +Each `groupId` should follow [Java's package name rules][1]. +This means it starts with a reversed domain name you control. + +Examples + +``` +org.apache.maven +org.apache.commons +``` + +There are many legacy projects that do not follow this convention and instead use single word group IDs. +However, it will be difficult to get a new single word group ID approved for inclusion in the Maven Central repository. Review Comment: I prefer group ID as the term unless you are referring specifically to the element in pom.xml. This is how we talked about linked lists when discussing the data structure but the class name is LinkedList. Prose is not code. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
