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

Docs: migrations column-type list is incomplete and "PKs must be Text" contradicts the first-class Uuid type / the NAP schema

Abierto Apto para principiantes
  • ¿Algo no está bien?
#72 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
csharp
Área
database, documentation

Línea de trabajo

Comienza con Website/src/docs/migrations.md y compara sus reglas de migración con SchemaYamlSerializer.ParseType, incluidos los tokens onDelete aceptados. Comprueba migrations/schema.yaml para ver el uso canónico de la clave primaria. Se considera terminado cuando la página enumera los tipos de columna y los valores de eliminación aceptados, e identifica claramente Uuid como el tipo previsto para la clave primaria.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Page

https://dataprovider.tech/docs/migrations/ (Website/src/docs/migrations.md)

A. The column-type list is incomplete

The docs say:

Supported column types include Text, Integer, Real, Blob, Boolean, DateTime, Guid, and vector types on PostgreSQL.

But SchemaYamlSerializer.ParseType accepts many more — including the ones almost every real schema needs and that the canonical NAP migrations/schema.yaml uses: Uuid, Int, BigInt, SmallInt, TinyInt, Json/Jsonb, Date, DateTimeOffset, Decimal(p,s), VarChar(n), NVarChar(n|max), Char(n), Float, Double, Money, Time, Xml, RowVersion, Geometry/Geography, Vector(n).

A reader following the docs literally would not know that DateTimeOffset, Json, Uuid, or Decimal even exist. Please publish the full accepted-token list (it can be generated straight from ParseType).

B. The "PKs must be Text" rule contradicts the first-class Uuid type

The Rules section says:

Primary keys must be UUIDs (Text at the column level, generated by your application).

But there is a first-class Uuid type, and the canonical NAP migrations/schema.yaml uses type: Uuid for every primary key. "Text at the column level" directly contradicts real, recommended usage. Please clarify that Uuid is the intended PK column type.

C. (Minor) onDelete tokens

The example only shows onDelete: NoAction. Worth listing all accepted values (NoAction/No_Action, Cascade, SetNull/Set_Null, SetDefault/Set_Default, Restrict).

These cost real investigation time (reading the serializer source) to resolve while authoring a production schema.

Lenguaje dominante
C#
Estrellas
67
Forks
4
Sin PR fusionados en 30 d

Preparar el entorno

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 Nimblesite/DataProvider

Todos los issues de Nimblesite/DataProvider

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.