elharo commented on code in PR #642:
URL: https://github.com/apache/maven-site/pull/642#discussion_r1913045355


##########
content/markdown/guides/mini/guide-naming-conventions.md:
##########
@@ -0,0 +1,122 @@
+<!--
+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. an `.jar` file), 
this artifact must be identifiable through a

Review Comment:
   a .jar file



##########
content/markdown/guides/mini/guide-naming-conventions.md:
##########
@@ -0,0 +1,122 @@
+<!--
+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. an `.jar` file), 
this artifact must be identifiable through a
+unique combination of three identifiers.
+This combination is called the "[Maven coordinates][4]" and consists of a 
project identifier (`groupId`), an artifact
+identifier (`artifactId`) and the version identifier (`version`).
+
+This document defines the naming conventions of Maven coordinates.
+
+You should follow this convention, whenever you create a new artifact, however 
Maven does not enforce any.
+
+## Project identifier
+
+The `groupId` uniquely identifies your project across all projects.

Review Comment:
   Again "project" is taken in Maven 4 for something else. We need a different 
word. 
   Also, prefer third person where possible. It might not be "your" project.  



##########
content/markdown/guides/mini/guide-naming-conventions.md:
##########
@@ -0,0 +1,122 @@
+<!--
+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. an `.jar` file), 
this artifact must be identifiable through a
+unique combination of three identifiers.
+This combination is called the "[Maven coordinates][4]" and consists of a 
project identifier (`groupId`), an artifact
+identifier (`artifactId`) and the version identifier (`version`).

Review Comment:
   comma after (`artifactId`)
   
   also better to use fewer parentheses. E.g.
   
   This combination is called the "[Maven coordinates][4]". Maven coordinates 
consist of a project identifier named `groupId`, an artifact identifier named 
`artifactId`, and a version identifier named `version`.
   
   Also we need a better word than "project" here now that Maven 4 is using 
"project" for what we used to call a "module". 
   
   



##########
content/markdown/guides/mini/guide-naming-conventions.md:
##########
@@ -0,0 +1,122 @@
+<!--
+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. an `.jar` file), 
this artifact must be identifiable through a
+unique combination of three identifiers.
+This combination is called the "[Maven coordinates][4]" and consists of a 
project identifier (`groupId`), an artifact
+identifier (`artifactId`) and the version identifier (`version`).
+
+This document defines the naming conventions of Maven coordinates.
+
+You should follow this convention, whenever you create a new artifact, however 
Maven does not enforce any.
+
+## Project identifier
+
+The `groupId` uniquely identifies your 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 (without version) and therefore 
should describe the artifacts content.

Review Comment:
   delete "(without version)"



##########
content/markdown/guides/mini/guide-naming-conventions.md:
##########
@@ -0,0 +1,122 @@
+<!--
+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. an `.jar` file), 
this artifact must be identifiable through a
+unique combination of three identifiers.
+This combination is called the "[Maven coordinates][4]" and consists of a 
project identifier (`groupId`), an artifact
+identifier (`artifactId`) and the version identifier (`version`).
+
+This document defines the naming conventions of Maven coordinates.
+
+You should follow this convention, whenever you create a new artifact, however 
Maven does not enforce any.
+
+## Project identifier
+
+The `groupId` uniquely identifies your 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

Review Comment:
   Don't we usually keep the group ID and change the artifact ID in this case?



##########
content/markdown/guides/mini/guide-naming-conventions.md:
##########
@@ -0,0 +1,122 @@
+<!--
+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. an `.jar` file), 
this artifact must be identifiable through a
+unique combination of three identifiers.
+This combination is called the "[Maven coordinates][4]" and consists of a 
project identifier (`groupId`), an artifact
+identifier (`artifactId`) and the version identifier (`version`).
+
+This document defines the naming conventions of Maven coordinates.
+
+You should follow this convention, whenever you create a new artifact, however 
Maven does not enforce any.

Review Comment:
   You should follow this convention whenever you create a new artifact.



-- 
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]

Reply via email to