vailabel/vailabel-studio

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

Open

#241 geöffnet am 19. Juni 2026

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (22 Forks)auto 404
documentationgood first issuehacktoberfest

Repository-Metriken

Stars
 (62 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Befolgen Sie die Schritte im Issue: Erstellen Sie einen neuen Abschnitt in CONTRIBUTE.md mit einer Schritt für Schritt Anleitung zum Forken, Branchen, Commiten mit konventionellen Commits, Ausführen von Checks, Erstellen von Changesets und Öffnen eines PR.
Tech Stack
Keine
Domain
developer experience
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90