Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Provide maturity annotation for classes and fields

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

Los mantenedores suelen responder en 2 días

@korikuzma ya está trabajando en esto.

Desde el 17/12/2024.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

enhancement

GKS schemas often include maturity model annotations on objects and properties to indicate some expectation of model stability. It'd be nice to access this somehow within VRS-Python.

  • Most naive solution: put it in the docstring. Not machine-readable, but simple to implement.
  • Maybe the next simplest solution: include it as part of the model_json_schema() output. This is computationally accessible, albeit somewhat indirectly so. It would most directly match the schema itself.
  • Implement as some kind of private or dunder field on each schema class, e.g. Allele.__maturity__ = <MaturityModel.TRIAL_USE>. Not sure of what the equivalent way to get property maturity would be, though.

Possible use cases/helper functions to implement

  • A function that takes a Ga4ghIdentifiableObject and tells you which components or properties are most immature, i.e. are most liable to change in structure in future releases
  • A function that takes a Ga4ghIdentifiableObject and tells you whether it contains any components or properties that are below a particular maturity model threshold and/or are deprecated
Lenguaje dominante
Python
Estrellas
64
Forks
44
Merge medio
4 d 4 h
PR fusionados (30 d)
8

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

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 ga4gh/vrs-python

Todos los issues de ga4gh/vrs-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.