📖 docs(contributing): expand CONTRIBUTING.md with full local dev and workflow guide#650
📖 docs(contributing): expand CONTRIBUTING.md with full local dev and workflow guide#650kubestellar-hive[bot] wants to merge 1 commit into
Conversation
- Add prerequisites table (Node.js 18+, npm, optional just) - Add local development setup steps - Add repository structure section with component map - Add code style / ESLint formatting guidance - Add PR workflow with DCO sign-off instructions - Add conventional commit examples - Retain pointer to docs site and OS-image repos Addresses: guide bead 27949a40 — CONTRIBUTING.md was a 4-line stub that redirected away without any website-specific contributor info. Signed-off-by: ci-maintainer <ci-maintainer@projectbluefin.hive>
hanthor
left a comment
hanthor
left a comment
There was a problem hiding this comment.
PR has merge conflicts with main branch. Please resolve CONTRIBUTING.md conflicts and re-sync with base branch, then we can approve.
hanthor
left a comment
hanthor
left a comment
There was a problem hiding this comment.
Good expansion of the CONTRIBUTING.md with concrete steps for first-timers. The fork/clone/branch workflow section was clearly missing. Approved.
hanthor
left a comment
hanthor
left a comment
There was a problem hiding this comment.
Code Review
Changes: 1 file, CONTRIBUTING.md (+194/-4). Replaces the 4-line stub with a comprehensive contributor guide.
Content quality ✅
- ✅ Clear prerequisites table (Node.js 18+, npm, optional
project-bluefin-website@0.1.0 build
vue-tsc && vite build)
- ✅ Step-by-step local dev setup (clone → install → dev server)
- ✅ Comprehensive repo structure map with component directories
- ✅ Code style/ESLint guidance consistent with project config
- ✅ Conventional commit examples match project conventions
- ✅ DCO sign-off instructions (On branch resolve-contributing-conflicts
nothing to commit, working tree clean) clear and correct - ✅ Points to TRANSLATION-GUIDE.md for i18n workflow
Structural note ⚠️
- This PR has merge conflicts with main (tracked as #654). PR #657 resolves these conflicts by keeping this branch's content. Once #657 is merged/cherry-picked, this PR's conflicts will be resolved.
Verdict
Well-structured, accurate, comprehensive. LGTM pending conflict resolution.
hanthor
left a comment
hanthor
left a comment
There was a problem hiding this comment.
Code Review
Changes: 1 file, CONTRIBUTING.md. Replaces 4-line stub with comprehensive guide.
Content quality: prerequisites, local dev setup, repo structure, code style, conventional commits, DCO sign-off all correct and well-structured. Points to TRANSLATION-GUIDE.md.
Note: Has merge conflicts (tracked as #654, PR #657 resolves). LGTM pending resolution.
hanthor
left a comment
hanthor
left a comment
There was a problem hiding this comment.
Reviewed — comprehensive CONTRIBUTING.md expansion with dev workflow. LGTM.
1 participant
Summary
Replaces the 4-line CONTRIBUTING.md stub (bead
27949a40) with a full contributor guide.Changes
just)bluespeed/,dakota/,knuckle/)git commit -s)Why
The old CONTRIBUTING.md read: "Thank you for contributing. See docs.projectbluefin.io/contributing." It did not describe the actual Vite+Vue+Tailwind stack or the repo structure. New contributors had no local dev path without reverse-engineering the justfile and package.json.
Refs #648