Back to .md Directory

Naming Conventions for avArc Project

Defines when to use 'avArc' vs 'avarc' across project names, Maven coordinates, Docker images, and package names.

May 2, 2026
0 downloads
2 views
ai
View source

What this file does

Defines when to use 'avArc' vs 'avarc' across project names, Maven coordinates, Docker images, and package names.

When to use it

  • Standardizing project name casing in a multi-module Maven project
  • Setting consistent naming for Docker images and packages
  • Writing documentation or user-facing text that references the project
  • Creating new Maven modules or artifacts for the same project

Assumes this stack

MavenDocker

Naming Conventions for avArc Project

Project Name

  • The project name is avArc (lowercase 'a', uppercase 'A', lowercase 'rc')
  • Always use "avArc" when referring to the project name in documentation, comments, and user-facing text
  • Artifact IDs and technical identifiers may use lowercase "avarc" for consistency with Maven conventions

Naming Conventions

  • Project display name: avArc
  • Maven groupId: org.avarc (lowercase)
  • Maven artifactIds: avarc-* (lowercase with hyphens)
  • Docker image names: avarc-* (lowercase with hyphens)
  • Package names: org.avarc.* (lowercase)

When to Use "avArc" vs "avarc"

  • Use avArc for:

    • Project name in <name> tags in POM files
    • Documentation and README files
    • User-facing text and descriptions
    • Comments explaining project context
  • Use avarc (lowercase) for:

    • Maven artifactIds
    • Docker image names
    • Package names
    • Technical identifiers
    • File and directory names

What's inside

Two sections: project name rule and a table of when to use each casing variant.

Change this for your project

  • Replace avArc with your own project display name
  • Replace org.avarc with your own Maven groupId
  • Replace avarc-* with your own artifact and image prefix

Where it goes

Keep it in your repository where the agent or team that needs it will read it.

Related Documents