vailabel/vailabel-studio

docs: Expand CONTRIBUTE.md with a step-by-step contribution workflow

Open

#241 ouverte le 19 juin 2026

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)TypeScript (22 forks)auto 404
documentationgood first issuehacktoberfest

Métriques du dépôt

Stars
 (62 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

Summary CONTRIBUTE.md lists apps and commands but doesn't tell a first-timer how to contribute (fork, branch, commit format, required checks, changesets, opening a PR). Add that walkthrough.

Where

  • CONTRIBUTE.md

Steps

  1. Branch: git checkout -b docs/contribute-workflow.
  2. Add a ## Submitting a Pull Request section covering, in order:
    • Fork → clone → yarn install.
    • Create a feature branch (feat/..., fix/..., docs/...).
    • Run yarn lint, yarn typecheck, yarn test before pushing.
    • Conventional commits — 2–3 examples (feat(studio): ..., fix(ai-models): ..., docs: ...). The repo uses commitlint.
    • Changesets — user-facing changes need yarn changeset (repo uses the .changeset workflow).
    • Push and open a PR against main.
  3. Run yarn lint.
  4. Commit docs: add PR workflow to CONTRIBUTE.md and open a PR.

Acceptance criteria

  • A newcomer can follow CONTRIBUTE.md end-to-end without prior repo knowledge.
  • Conventional-commit and changeset steps are documented.

Good first issue — comment here if you'd like to take it.

Guide contributeur

Direction de recherche
Suivez les étapes décrites dans le problème : créez une nouvelle section dans CONTRIBUTE.md avec un guide étape par étape sur la façon de forker, créer une branche, effectuer un commit avec des messages conventionnels, exécuter les vérifications, créer des changesets et ouvrir une PR.
Stack technique
Aucun
Domaine
developer experience
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90