a2ui-project / a2ui-project/a2ui

Create a `specification-change` skill

Ouverte
#1,689 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
P2
Langage dominant
TypeScript
Étoiles
16.4k
Forks
1.3k
Merge moyen
2 j 13 h
PR mergées (30 j)
134

Description

A skill to help with updating the specifications. It should explain:
- The different states specifications can be in e.g. draft, candidate, final etc.
- The types of changes that are allowed in each state
- How to create a new specification
- The writing style to use
- The set of files to consider e.g. both Markdown and JSON
- How to write and run the appropriate tests

Perhaps most of this is just regular documentation at `specification/docs` that is referenced by a skill. That way, it can also be discovered by humans easily.

The skill should specifically mention some things that need to be considered that are non-obvious including:
- Make sure you update the rules governing the structure of catalog documents, including the "allowed schemas" in `common-types.json` that can be referenced from component and function schemas.

This comes from @gspencergoog 's idea in https://github.com/a2ui-project/a2ui/pull/1629#discussion_r3424979613

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Look at the existing skills in the codebase to understand their structure and location. Review the specification documentation at `specification/docs` to understand the content that needs to be referenced. The skill should guide users through specification states, change types, and updating `common-types.json`. Test by creating and running the skill in the development environment.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
json, markdown, typescript
Domaine
documentation, tooling
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
65/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.