Flux de développement
Démarrer le projet
Comprendre les besoins et écrire le code
C'est un processus complexe, mais dans la plupart des cas, il se résume à trois choses :
- Clarifier l'entrée :
vseed - Clarifier la sortie :
vseeddevientadvancedVSeed, ouadvancedVSeeddevientspec - Écrire le code et garantir que les nouvelles entrées produisent les sorties attendues
Le playground (apps/website/docs/fr-FR/playground/index.mdx) peut être utilisé pour le débogage et le développement.
Créer de nouveaux cas de test
Si nécessaire, il est possible d'envisager la création de nouveaux cas de test.
Lorsque la couverture diminue, de nouveaux cas de test doivent être créés.
Dans le répertoire packages/vseed/tests/*, créez un nouveau fichier testName.json et écrivez-y la VSeed DSL.
Exécuter :
Exécuter les tests unitaires et mettre à jour la couverture
Vérifiez trois choses :
- Tous les tests passent
- Les changements de snapshots sont conformes aux attentes
- La couverture n'a pas diminué
Les changements de couverture seront automatiquement mis à jour dans README.md
Mettre à jour la documentation des options de configuration
Si vous modifiez les définitions TypeScript des types de graphiques, veuillez mettre à jour la documentation des options de configuration.
Toutes les définitions de types sous packages/vseed/src/types/chartType correspondent à la documentation des options de configuration de chaque graphique. En cas de changement, veuillez impérativement la mettre à jour.
Publication et soumission
Après avoir exécuté pnpm changeset, suivez les indications pour effectuer les opérations suivantes :
- Sélectionner les packages qui changent ; dans la plupart des cas, seulement
vseed - Respecter le versionnement sémantique et choisir le type de changement. Dans la grande majorité des cas, appuyez deux fois sur Entrée pour ignorer
majoretminor, puis choisissezpatch - Saisir la description du changement, par exemple :
fix: chart render error caused by only one measure
Une fonctionnalité ou un Bugfix correspond à un changeset et à un commit
Un Pull Request correspond à une issue
Un Pull Request contenant plusieurs fonctionnalités ou plusieurs Bugfixes correspond à plusieurs changesets et plusieurs commits