Skip to content

fix(docs): fix CONTRIBUTING.md#109

Open
KhaledSaeed18 wants to merge 3 commits into
ui-layouts:mainfrom
KhaledSaeed18:fix/contributing-docs-cleanup
Open

fix(docs): fix CONTRIBUTING.md#109
KhaledSaeed18 wants to merge 3 commits into
ui-layouts:mainfrom
KhaledSaeed18:fix/contributing-docs-cleanup

Conversation

@KhaledSaeed18

@KhaledSaeed18 KhaledSaeed18 commented May 8, 2026

Copy link
Copy Markdown

Summary

Overhauled CONTRIBUTING.md to fix multiple outdated and incorrect references.

Changes

# Issue Before After
1 Project name ui-layout uilayouts
2 Package manager npm Bun
3 Animation library framer → framer.com/motion Motion → motion.dev
4 Clone URL ui-layouts/uilayout.git (original repo) <YOUR_USERNAME>/uilayouts.git (fork)
5 cd command cd uilayout cd uilayouts
6 Install command pnpm install bun install
7 Dev server step missing added bun dev
8 Lockfile in tree pnpm-lock.yaml bun.lock
9 Folder structure outdated flat single-app structure current Turborepo monorepo layout
10 Monorepo context not mentioned added Turborepo intro line

Type of Change

  • Documentation fix (non-breaking)

Checklist

  • All incorrect package manager references updated to Bun
  • Animation library link updated to motion.dev
  • Clone URL updated to point to contributor's fork
  • Project name consistent throughout (uilayouts)
  • Folder structure reflects current monorepo layout
  • bun dev step added to development workflow

Summary by CodeRabbit

  • Documentation
    • Contribution guidelines updated to reflect the current monorepo workflow, how to find issues and contact maintainers.
    • Development setup instructions simplified to Bun-based commands for local development.
    • Repository layout and configuration docs revised to describe the apps/packages monorepo structure and project tooling (Turborepo, Bun, Motion, MDX).
  • Style
    • Commit message guidance lightly reformatted for clarity while retaining conventional-commits conventions.

@vercel

vercel Bot commented May 8, 2026

Copy link
Copy Markdown

@KhaledSaeed18 is attempting to deploy a commit to the UI-Layouts OSS Program Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented May 8, 2026

Copy link
Copy Markdown

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 24f702bd-309a-48c3-adc2-6dca36f5f7ff

📥 Commits

Reviewing files that changed from the base of the PR and between f6d9be5 and d47c592.

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

📝 Walkthrough

Walkthrough

CONTRIBUTING.md is updated to document the Turborepo-managed monorepo architecture, switching development instructions from npm/pnpm to Bun, and replacing the folder structure section to reflect current apps/ and packages/ organization. Commit conventions are slightly reformatted while core guidance is preserved.

Changes

Monorepo Contributing Guide Update

Layer / File(s) Summary
Project Overview and Tooling
CONTRIBUTING.md
Opening contribution text clarified; tooling section updated to document Turborepo, Bun package manager, Motion animations, and next-mdx.
Development Setup Workflow
CONTRIBUTING.md
Fork/clone instructions and "Create a new branch" step retained; development commands replaced with Bun workflow (bun install, bun dev).
Repository Structure
CONTRIBUTING.md
Folder structure section rewritten to document monorepo layout with apps/ and packages/ directories, component paths, and top-level configuration files (biome.json, turbo.json).
Development Conventions
CONTRIBUTING.md
Commit convention categories and examples updated with revised formatting while maintaining conventional commits guidance.
Component Contribution Guidelines
CONTRIBUTING.md
"Requests for new components" section unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A garden of docs now blooms so bright,
With Bun commands and Turborepo might,
The monorepo laid out clear and wide,
Contributors hop in with grateful pride! 🌿

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'fix(docs): fix CONTRIBUTING.md' is vague and uses generic phrasing—it states the file being updated but doesn't convey what was actually fixed or why, failing to summarize the substantive changes made. Revise the title to be more descriptive, such as 'fix(docs): update CONTRIBUTING.md for uilayouts monorepo and Bun' to clearly indicate the main changes (monorepo structure update and package manager switch).
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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`:
- Around line 55-91: In CONTRIBUTING.md locate the fenced code block that
contains the repository tree (the triple-backtick block showing uilayouts/ ...
CONTRIBUTING.md) and change its opening fence from ``` to ```text so the block
is explicitly marked as plain text; this addresses the MD040 lint rule by adding
the language tag to the existing tree block.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: ad1e3063-9b39-4fa4-9bf0-d3fb676f3d20

📥 Commits

Reviewing files that changed from the base of the PR and between bd62672 and 92ec3ae.

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

Comment thread CONTRIBUTING.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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 101: Update the `refactor` bullet in CONTRIBUTING.md so the phrase reads
"code-related" instead of "code related"; locate the line containing the
backticked `refactor` bullet and replace the text between the backticks'
description to `refactor`: any code-related change that is not a fix nor a
feature to fix the hyphenation.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: e40a1522-eb53-4f54-858e-0b62138d15a0

📥 Commits

Reviewing files that changed from the base of the PR and between 92ec3ae and f6d9be5.

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

Comment thread CONTRIBUTING.md Outdated
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.

1 participant