docs: add contributor guides for local development#19962
docs: add contributor guides for local development#19962Syroxivoss wants to merge 2 commits intotailwindlabs:mainfrom
Conversation
|
Caution Review failedPull request was closed or merged during review WalkthroughReworks the repository documentation and contributor workflow: replaces the top-level contributing guide with a monorepo-focused workflow that pins tool versions (Node 24+, pnpm 9.6.0, Rust 1.85.0), adds Corepack-based setup and Rust wasm target instructions, and prescribes env checks and watch/test loops. Adds docs: ARCHITECTURE, BUILD, EXTENDING, RUNBOOK, TESTING, TROUBLESHOOTING. Updates PR template with an “Impacted areas” section and converts multiple package README contributing links from absolute GitHub URLs to relative paths. 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.github/CONTRIBUTING.md (1)
83-86: Consider varying bullet openings for scanabilityThe four bullets all start with “If”, which makes this section harder to skim quickly. Rewording one or two bullets would improve readability.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/CONTRIBUTING.md around lines 83 - 86, The four guidance bullets all begin with "If", which reduces scanability; edit the bullet list to vary openings—rewrite one or two bullets to start with an imperative or subject (e.g., "Start in that adapter when the bug only shows up in Vite, PostCSS, or Webpack" or "For candidate discovery, roots, ignore rules, or scan performance, begin in oxide") while preserving the original meaning and order; update the bullets that reference the compiler, oxide, and packages/tailwindcss to use mixed openings for easier skimming and ensure punctuation/formatting remains consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/CONTRIBUTING.md:
- Line 21: The CONTRIBUTING.md currently instructs using "rustup default stable"
which conflicts with the pinned Rust 1.85.0 requirement and mutates the user's
global toolchain; replace that flow so the doc installs and uses the exact
toolchain for the repo by running "rustup toolchain install 1.85.0", then
"rustup override set 1.85.0" for the project, and add the wasm target with
"rustup target add wasm32-wasip1-threads --toolchain 1.85.0" instead of the
floating "rustup default stable" and the previous target command; update the
lines around the existing rustup commands in .github/CONTRIBUTING.md (the block
containing "rustup default stable" and "rustup target add
wasm32-wasip1-threads") accordingly.
---
Nitpick comments:
In @.github/CONTRIBUTING.md:
- Around line 83-86: The four guidance bullets all begin with "If", which
reduces scanability; edit the bullet list to vary openings—rewrite one or two
bullets to start with an imperative or subject (e.g., "Start in that adapter
when the bug only shows up in Vite, PostCSS, or Webpack" or "For candidate
discovery, roots, ignore rules, or scan performance, begin in oxide") while
preserving the original meaning and order; update the bullets that reference the
compiler, oxide, and packages/tailwindcss to use mixed openings for easier
skimming and ensure punctuation/formatting remains consistent.
🪄 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: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 995edaa5-5e24-4a73-9f1c-ef6c8e0d3cb1
📒 Files selected for processing (17)
.github/CONTRIBUTING.md.github/PULL_REQUEST_TEMPLATE.mdREADME.mddocs/ARCHITECTURE.mddocs/BUILD.mddocs/EXTENDING.mddocs/RUNBOOK.mddocs/TESTING.mddocs/TROUBLESHOOTING.mdpackages/@tailwindcss-browser/README.mdpackages/@tailwindcss-cli/README.mdpackages/@tailwindcss-node/README.mdpackages/@tailwindcss-postcss/README.mdpackages/@tailwindcss-upgrade/README.mdpackages/@tailwindcss-vite/README.mdpackages/@tailwindcss-webpack/README.mdpackages/tailwindcss/README.md
|
Hey! I appreciate the PR, but let's open issues / discussions first before opening (big) PRs like this. In this case, we want to keep documentation simple and lean. This change adds a lot of new files, and it also means that we have to keep these files in sync to be useful whenever we work on anything. I have a suspicion that a lot of this was generated by AI, and since the AI was able to figure things out, there doesn't seem to be a good reason to add these files in the first place. Thanks for your contribution |
2 participants
Summary
Adds contributor-focused documentation for building, testing, and troubleshooting the project locally.
What changed
Motivation
The project has a complex monorepo + Rust + WASM setup. These docs make onboarding easier for new contributors, especially on Windows.
Validation
Notes
This PR focuses only on documentation improvements and does not change runtime behavior.