Skip to content

fix: resolve merge conflicts in CONTRIBUTING.md#657

Open
hanthor wants to merge 3 commits into
mainfrom
resolve-contributing-conflicts
Open

fix: resolve merge conflicts in CONTRIBUTING.md#657
hanthor wants to merge 3 commits into
mainfrom
resolve-contributing-conflicts

Conversation

@hanthor
Copy link
Copy Markdown
Member

@hanthor hanthor commented May 29, 2026

Summary

Resolves the merge conflicts in PR #650 (docs/contributing-guide). The comprehensive CONTRIBUTING.md from the docs/contributing-guide branch was kept in its entirety.

Closes #654

Test plan

  • CONTRIBUTING.md renders correctly on GitHub preview
  • No merge conflict markers remain

Summary by CodeRabbit

  • Documentation
    • Restructured contribution guide with clearer repository scope and prerequisites
    • Enhanced local development setup instructions with explicit commands and tool requirements
    • Added repository structure documentation and improved guidance for contributing content and translations
    • Streamlined PR workflow with updated commit conventions and DCO signoff procedures

Review Change Stack

ci-maintainer and others added 2 commits May 24, 2026 21:53
- 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>
Resolves the merge conflicts in PR #650 by keeping the comprehensive
contributing guide changes from the docs/contributing-guide branch.

Closes #654
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2026

Warning

Review limit reached

@hanthor, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 50 minutes and 35 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 2d6b4e2a-624a-445d-adad-df698f1b6086

📥 Commits

Reviewing files that changed from the base of the PR and between e534b9e and 7dc2401.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
📝 Walkthrough

Walkthrough

CONTRIBUTING.md is rewritten to provide clearer guidance for website contributors. The introduction clarifies this repo is website-only with links to other Bluefin repositories. Setup guidance is expanded with tabular prerequisites, explicit local development commands, and a new repository structure section. Making changes guidance directs contributors to specific content locations and translations. Code style rules are formalized with specific formatting requirements. PR workflow includes detailed submission steps, commit conventions, and DCO signoff commands. Support channels replace prior security guidance.

Changes

Contribution Guide Rewrite

Layer / File(s) Summary
Introduction and Scope
CONTRIBUTING.md
Introduction clarifies website-only scope and points to separate Bluefin/OS repositories and architecture diagram.
Getting Started Setup
CONTRIBUTING.md
Prerequisites are presented in a tool/version table, local development commands are expanded with explicit npm and optional just usage, and a new "Repository Structure" section documents directory layout and Vite app organization.
Making Changes and Code Style
CONTRIBUTING.md
Guidance on editing main-site content and translations (including link to translation guide) is combined with expanded code formatting rules (indentation, quotes, style blocks, console usage) and linting workflow.
PR Submission and DCO Signoff
CONTRIBUTING.md
PR workflow includes step-by-step submission process, explicit commit message conventions with examples, and a dedicated DCO section with git signoff commands.
Community Support Channels
CONTRIBUTING.md
Security guidance is removed and replaced with "Questions?" section linking to Discord, Discussions, and GitHub issues.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guide rewrit with clearer care,
Now website scope is crystal-fair,
Prerequisites in tables neat,
Translations, DCO—complete!
Bluefin's path to contrib's door,
Better docs to help folks soar! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main change: resolving merge conflicts in CONTRIBUTING.md, which is the primary objective.
Linked Issues check ✅ Passed The PR successfully resolves the merge conflicts in CONTRIBUTING.md as required by issue #654, ensuring the file is conflict-free.
Out of Scope Changes check ✅ Passed All changes are scoped to resolving merge conflicts in CONTRIBUTING.md; no out-of-scope modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch resolve-contributing-conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 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 169: The code block that shows commit message examples lacks a language
specifier, so update that fenced code block to include a language hint (e.g.,
plaintext) by changing the opening triple backticks to ```plaintext; locate the
commit examples block in CONTRIBUTING.md (the block containing "feat(knuckle):
add download counter..." and "fix(locales): correct typo...") and replace its
opening fence accordingly so the examples render with proper syntax
highlighting.
- Line 64: The code block showing the repository structure uses a bare fence
(```) without a language specifier; update the opening fence to include a
language tag (e.g., change the leading ``` to ```plaintext or ```text) so the
repository tree is rendered with correct formatting and highlighting in
CONTRIBUTING.md — locate the triple-backtick fence around the "website/" tree
and replace it with a fenced block specifying plaintext.
- Line 21: Update the Node.js prerequisite table row that currently reads "|
[Node.js](https://nodejs.org/) | 18 or higher | Runtime + build toolchain |" to
specify the supported LTS—e.g. change the middle cell to "24+ (LTS)" or "current
LTS or later" so contributors are directed to a supported runtime; ensure the
table formatting and link text remain unchanged.
🪄 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: 26507523-8087-43dd-b368-6846b6170807

📥 Commits

Reviewing files that changed from the base of the PR and between b3902e1 and e534b9e.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Member Author

@hanthor hanthor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed — resolves merge conflicts correctly. LGTM.

- Add 'plaintext' specifier to repo structure and commit example fences
- Update Node.js prerequisite from '18 or higher' to '24+ (current LTS)'

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@hanthor
Copy link
Copy Markdown
Member Author

hanthor commented May 31, 2026

Fixed CodeRabbit's three items: added plaintext fence specifiers to the repo structure tree (line 64) and commit examples block (line 169), and updated Node.js prerequisite from '18 or higher' to '24+ (current LTS)'.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

resolve: merge conflicts in CONTRIBUTING.md — PR #650

1 participant