Repo naming conventions: Tier 1 Guideline

Abierto
#17 0 comentarios 0 reacciones 1 asignado Ver en GitHub

@Honyii ya está trabajando en esto.

Desde el 29/10/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

This issue is to establish a consistent, descriptive, and maintainable repo naming guideline for higher tiers and the convention should make repo easier to understand and discover while maintaining the project's identity.

Here are general/default rules we can adapt

  • Lowercase by default.
    • Use lowercase numbers and letters, separated by hyphens. For instance, imagine a project called OpenMBEE Model Manager with three repositories:
Component Consistent naming Inconsistent naming
Web application model-manager-web ModelManager_Web
API model-manager-api ModelManagerAPI
Documentation model-manager-docs Model_Manager_Docs
  • Descriptive.
    • The name should communicate the project's purpose, product, or component. For instance, imagine a project providing tools for validating SysML models:
Component Descriptive naming Vague naming
Model validator sysml-model-validator project-tool
Model examples sysml-model-examples examples2
Validation rules sysml-validation-rules misc
  • Prefix only when useful.
    • Use an established product or architecture prefix where it adds meaningful context. For instance, imagine a product called Flexo MMS with components that belong to that product and a shared utility used across several products:
Component Appropriate prefix Unnecessary or unclear prefix
Layer 1 service flexo-mms-layer1-service openmbee-flexo-mms-layer1-service
SysML v2 integration flexo-mms-sysmlv2 sysmlv2-integration
Shared logging utility logging-utils flexo-mms-logging-utils

The shared utility doesn't need the Flexo MMS prefix if it serves the wider ecosystem rather than that specific product.

  • No unnecessary abbreviations.
    • Use established domain abbreviations such as SysML, API, and MMS, but avoid obscure shorthand.
Component Clear naming Unclear naming
Model validator sysml-model-validator smv
API documentation model-api-docs mad
Model examples sysml-model-examples sme-repo

The aim isn't to eliminate all abbreviations but to use terms that contributors in the ecosystem will understand.

  • Avoid temporary labels.
    • Don't use names like new, final, latest, test2, or v2 unless that label is genuinely part of the project's identity.
Purpose Appropriate naming Temporary or confusing naming
Main integration sysmlv2-integration sysmlv2-new
Replacement implementation sysmlv2-integration sysmlv2-final
Automated test suite sysmlv2-integration-tests sysmlv2-test2
  • One naming pattern per component family.
    • Related repositories should use consistent ordering of product, component, and role. For instance, imagine a project called Flexo MMS with three components:
Component Consistent naming Inconsistentnaming
Layer 1 service flexo-mms-layer1-service flexo-mms-layer1-service
SysML v2 integration flexo-mms-sysmlv2 sysmlv2-flexo-integration
  • Preserve established names.
    • Existing names can remain where they are recognized, externally referenced, or required by a platform.
  • Document exceptions.
    • A maintainer or designated repository owner should explain and approve deviations for new Tier 1 repositories.
Action Items for all
  • Review the proposed naming rules and examples.
  • Discuss whether the proposed repository tiers and their criteria make sense.
  • Suggest changes, edge cases, and exceptions based on existing projects and workflows.
  • Agree on the default naming format and who approves exceptions.
Action item for me; @Honyii
  • [ ] Incorporate feedback and update the policy and examples.
Lenguaje dominante
HTML
Estrellas
2
Forks
0
Merge medio
15 h 17 min
PR fusionados (30 d)
5

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Open-MBEE/opensysml.github.io

Todos los issues de Open-MBEE/opensysml.github.io

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.