Naming Conventions

Repositories

Be Consistent

• Use lowercase and dashes for all repository names.

Be Descriptive & Concise

• Naming Pattern: <domain>-<subdomain (optional)>-<object>. A descriptive name makes the repo easy to find and a short name makes the repo easy to use.

Domains and Subdomains

• Domains: Broad categories like etl, web, matching, infra to define the primary focus of the repo.
• Subdomains: Further specificity such as ingestion, testing, ner. This is optional and can be omitted if it does not add significant value or clarity.

Objects

• Objects: Indicate the repository's main component or output, e.g., pipeline, app, agent.

Examples:

• etl-ingestion-pipelines
• elt-transformation-pipelines.
• matching-ner-pipeline
• matching-classification-agent

If including a subdomain doesn't contribute meaningfully to describing the repository's content or purpose, it's better to leave it out for brevity.

• productivity-agents