vailabel/vailabel-studio
在 GitHub 查看docs: Expand CONTRIBUTE.md with a step-by-step contribution workflow
Open
#241 创建于 2026年6月19日
documentationgood first issuehacktoberfest
仓库指标
- Star
- (62 star)
- PR 合并指标
- (PR 指标待抓取)
描述
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
- Branch:
git checkout -b docs/contribute-workflow. - Add a
## Submitting a Pull Requestsection covering, in order:- Fork → clone →
yarn install. - Create a feature branch (
feat/...,fix/...,docs/...). - Run
yarn lint,yarn typecheck,yarn testbefore pushing. - Conventional commits — 2–3 examples (
feat(studio): ...,fix(ai-models): ...,docs: ...). The repo usescommitlint. - Changesets — user-facing changes need
yarn changeset(repo uses the.changesetworkflow). - Push and open a PR against
main.
- Fork → clone →
- Run
yarn lint. - Commit
docs: add PR workflow to CONTRIBUTE.mdand 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.