Skip to content

Repository & Naming

Conventions for canonical URLs, package ids, branching, and directory layout form the foundation of every IG project. Getting these right early prevents painful migrations later. A well-structured repository enables tooling to work out of the box, helps new team members onboard quickly, and makes CI pipelines straightforward to configure.

Repository and naming patterns address the most common structural problems in IG projects:

  • Inconsistent names across releases break downstream dependents
  • Unnavigable repos slow down onboarding and code review
  • Non-standard layouts break CI paths and IG Publisher expectations

The Repository & Naming provide essential capabilities:

Canonical URL and Package ID

Ensure stable discovery and dependency management across IGs by establishing consistent, predictable identifiers from the start of the project.

Key Benefits: - Predictable imports - Clear provenance

Standard IG Layout

Keep authors and tools in sync by adopting the HL7 IG Publisher folder schema. When everyone follows the same conventions, onboarding is faster, CI is simpler, and cross-IG contributions become practical.

Key Benefits: - Onboard faster - Simpler CI