docs: resolve merge conflicts in CONTRIBUTING.md (closes #654)#662
Open
clubanderson wants to merge 2 commits into
Open
docs: resolve merge conflicts in CONTRIBUTING.md (closes #654)#662clubanderson wants to merge 2 commits into
clubanderson wants to merge 2 commits 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>
Merge PR projectbluefin#650 (docs/contributing-guide) with current main by combining both versions into one comprehensive guide: - Keep PR projectbluefin#650's structured Prerequisites table, numbered Local Development steps, HMR note, Repository Structure tree, Making Changes section, detailed Code Style rules, DCO sign-off instructions, and Questions section - Keep main's Testing section (unit tests + Playwright navbar visual tests) - Keep main's Security Issues section - Merge commands table to include all commands from both versions - Consolidate Translations subsection from both the i18n section (main) and the Translations subsection (PR projectbluefin#650) Closes projectbluefin#654 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
📝 WalkthroughWalkthrough
ChangesBluefin Contributing Guide Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Line 86: Remove the stray character and fix alignment for the repository tree
entry for locales/ by replacing the malformed line "locales/ # i18n
translation files (JSON) ├" with a clean, consistent entry like "locales/
# i18n translation files (JSON)" so the directory map renders the same as
surrounding entries and the stray '├' is eliminated.
- Around line 42-43: CONTRIBUTING.md currently contradicts the justfile: verify
the justfile's serve: target (which runs "npm run dev") and update
CONTRIBUTING.md so "just serve" is documented only as the development server
(running npm run dev); also identify and document the actual just target used
for production preview (or add one to the justfile) so the doc's
production-preview instructions reference the correct target instead of reusing
"just serve".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 5b7dcafa-b8b8-4bd4-b3f3-01aae95815c1
📒 Files selected for processing (1)
CONTRIBUTING.md
Comment on lines
+42
to
+43
| # or, if you have just installed: | ||
| just serve |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify how `just serve` is actually defined.
fd -i '^justfile$|\.justfile$' --exec sh -c 'echo "==> $1"; sed -n "1,220p" "$1"' sh {}Repository: projectbluefin/website
Length of output: 292
Fix inconsistent documentation for just serve in CONTRIBUTING.md
justfile defines serve: to run npm run dev, but CONTRIBUTING.md describes just serve as both a dev-server command (lines 42-43) and a production preview (lines 59-60). Make these consistent with the actual just target(s), or document the correct target for production preview.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` around lines 42 - 43, CONTRIBUTING.md currently contradicts
the justfile: verify the justfile's serve: target (which runs "npm run dev") and
update CONTRIBUTING.md so "just serve" is documented only as the development
server (running npm run dev); also identify and document the actual just target
used for production preview (or add one to the justfile) so the doc's
production-preview instructions reference the correct target instead of reusing
"just serve".
| │ ├── dakota/ # Dakota-specific components | ||
| │ └── knuckle/ # Knuckle-specific components | ||
| ├── composables/ # Reusable Vue composables | ||
| locales/ # i18n translation files (JSON) ├ |
Contributor
There was a problem hiding this comment.
Repository tree entry for locales/ appears malformed.
The stray ├ and alignment on this line make the directory map ambiguous. Clean this line so the tree renders consistently with the surrounding entries.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` at line 86, Remove the stray character and fix alignment for
the repository tree entry for locales/ by replacing the malformed line "locales/
# i18n translation files (JSON) ├" with a clean, consistent entry like
"locales/ # i18n translation files (JSON)" so the directory map renders
the same as surrounding entries and the stray '├' is eliminated.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves the merge conflicts in PR #650. Closes #654
Summary by CodeRabbit