docs: add note about single-issue PRs to contributing guide#3044
docs: add note about single-issue PRs to contributing guide#3044
Conversation
Add a prominent notice at the top of CONTRIBUTING.md clarifying that we only accept PRs addressing a single issue, not multiple fixes. https://claude.ai/code/session_011ZNQd5zkf38piSMhWbgiWt
|
WalkthroughThis pull request updates the CONTRIBUTING.md file to add a new policy requirement stating that pull requests must address a single issue. The change explicitly prohibits including multiple unrelated fixes or features within the same pull request. This is a documentation-only modification with no impact on code logic or behavior. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (3 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 |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
![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
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Around line 9-10: Wrap or reflow lines in CONTRIBUTING.md to ensure no line
exceeds 100 characters per Prettier's printWidth: 100; specifically reformat the
paragraph starting "**Important:** We only accept PRs that address a single
issue..." (and any other long lines in the file) so each line is <=100 chars,
then run Prettier (or your editor's format command) to apply consistent Markdown
formatting before committing.
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{js,ts,jsx,tsx,json,md,yaml,yml}
📄 CodeRabbit inference engine (AGENTS.md)
Format code using Prettier before committing
Files:
CONTRIBUTING.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (27)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
- GitHub Check: sdk-compat / Node.js 20.20 (ubuntu-latest)
- GitHub Check: sdk-compat / Bun Runtime
- GitHub Check: sdk-compat / Cloudflare Workers
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: sdk-compat / Deno Runtime
- GitHub Check: typecheck / typecheck
- GitHub Check: sdk-compat / Node.js 22.12 (ubuntu-latest)
🔇 Additional comments (1)
CONTRIBUTING.md (1)
9-10: Excellent placement and clear policy statement!The single-issue PR policy is clearly communicated and positioned prominently where contributors will see it early. The wording is professional and provides actionable guidance.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
| > **Important:** We only accept PRs that address a single issue. Please do not submit PRs containing multiple unrelated fixes or features. If you have multiple contributions, open a separate PR for each one. | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if Prettier is available and verify formatting status
# First, check if prettier is installed (either locally or globally)
if command -v prettier &> /dev/null; then
echo "Prettier found in PATH"
prettier --version
elif [ -f "node_modules/.bin/prettier" ]; then
echo "Prettier found in node_modules"
./node_modules/.bin/prettier --version
else
echo "Checking for Prettier in package.json..."
if [ -f "package.json" ]; then
grep -q "prettier" package.json && echo "Prettier is in package.json" || echo "Prettier NOT in package.json"
fi
fi
# Check if CONTRIBUTING.md exists
if [ -f "CONTRIBUTING.md" ]; then
echo -e "\n=== File exists ==="
wc -l CONTRIBUTING.md
# Try to run prettier check if available
if command -v prettier &> /dev/null; then
echo -e "\n=== Prettier check result ==="
prettier --check CONTRIBUTING.md 2>&1 || echo "File needs formatting or prettier failed"
elif [ -f "node_modules/.bin/prettier" ]; then
echo -e "\n=== Prettier check result ==="
./node_modules/.bin/prettier --check CONTRIBUTING.md 2>&1 || echo "File needs formatting or prettier failed"
else
echo -e "\n=== Prettier not available, showing first 20 lines ==="
head -20 CONTRIBUTING.md
fi
else
echo "CONTRIBUTING.md not found"
fiRepository: triggerdotdev/trigger.dev
Length of output: 1509
🏁 Script executed:
#!/bin/bash
# Check prettier configuration in the repo
if [ -f ".prettierrc" ] || [ -f ".prettierrc.json" ] || [ -f ".prettierrc.js" ] || [ -f ".prettierrc.yaml" ] || [ -f ".prettierrc.yml" ] || [ -f "prettier.config.js" ]; then
echo "=== Prettier configuration found ==="
ls -la | grep -i prettier
[ -f ".prettierrc" ] && echo -e "\n.prettierrc content:" && cat .prettierrc
[ -f ".prettierrc.json" ] && echo -e "\n.prettierrc.json content:" && cat .prettierrc.json
fi
# Check package.json for prettier config
if [ -f "package.json" ]; then
echo -e "\n=== Checking package.json for prettier config ==="
jq '.prettier // .devDependencies.prettier // "No prettier config"' package.json 2>/dev/null || echo "Could not parse package.json"
fiRepository: triggerdotdev/trigger.dev
Length of output: 306
🏁 Script executed:
#!/bin/bash
# Read prettier configuration
echo "=== prettier.config.js ==="
cat prettier.config.js
echo -e "\n=== .prettierignore ==="
cat .prettierignore
echo -e "\n=== Reading full CONTRIBUTING.md to check formatting ==="
cat -n CONTRIBUTING.mdRepository: triggerdotdev/trigger.dev
Length of output: 14232
Ensure this markdown file complies with Prettier formatting (printWidth: 100).
Multiple lines in CONTRIBUTING.md exceed the configured 100-character line width. The file should be formatted with Prettier before committing, as required by the coding guidelines for markdown files.
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` around lines 9 - 10, Wrap or reflow lines in CONTRIBUTING.md
to ensure no line exceeds 100 characters per Prettier's printWidth: 100;
specifically reformat the paragraph starting "**Important:** We only accept PRs
that address a single issue..." (and any other long lines in the file) so each
line is <=100 chars, then run Prettier (or your editor's format command) to
apply consistent Markdown formatting before committing.
3 participants
Add a prominent notice at the top of CONTRIBUTING.md clarifying that we only accept PRs addressing a single issue, not multiple fixes.
https://claude.ai/code/session_011ZNQd5zkf38piSMhWbgiWt