Update contribution guidelines in README

[conorluddy]

Clarify contribution guidelines and expectations.

[claude]

Code Review: PR #100 - Update contribution guidelines

Overview

This PR updates the README's contribution section to set clearer expectations about review timelines and encourage forking for customization.

✅ Positive Aspects

1. Transparency: Honestly communicates the maintainer's bandwidth constraints
2. Clear Expectations: Helps contributors understand that PRs may not be reviewed quickly
3. Practical Alternative: Suggests forking as a viable path for those needing immediate customizations
4. Maintains Requirements: Keeps the technical contribution requirements intact

📝 Suggestions for Improvement

1. Tone Optimization

The current warning block might discourage valuable contributions. Consider softening the message while maintaining honesty:

> [!NOTE]
> I appreciate contributions! Please note that due to other priorities, PR reviews may take time. If you need immediate customizations, feel free to fork the repo. Quality contributions are always welcome and will be reviewed when bandwidth allows.

Rationale:

• Changes WARNING to NOTE (less discouraging)
• Keeps transparency but frames it more positively
• Emphasizes that quality contributions ARE welcome

2. Consider Adding Contribution Priorities

Help contributors understand what's most valuable:

**Priority contributions** (faster review):
- Bug fixes with reproducible test cases
- Performance improvements with benchmarks
- Test coverage improvements
- Documentation improvements

**Lower priority** (slower review):
- New features (consider forking for immediate needs)
- Major architectural changes

3. Section Header Clarity

Consider renaming "PR requirements:" to "Contribution Requirements:" for better clarity.

🔍 Technical Review

• ✅ No code changes - documentation only
• ✅ Markdown syntax is correct
• ✅ GitHub alert syntax (> [!WARNING]) is valid
• ✅ No test coverage impact
• ✅ No security concerns
• ✅ Maintains existing technical requirements

🎯 Alignment with Project Goals

From CLAUDE.md context:

• ✅ Maintains quality standards (tests, coverage, linting, build)
• ✅ Transparent about project maintenance status
• ⚠️ Could be more welcoming to encourage community engagement

🤔 Questions for Consideration

1. Triage System: Would it help to use GitHub issue labels (e.g., good-first-issue, priority-review) to signal which contributions would get faster attention?

2. Community Maintainers: Consider inviting trusted contributors to become co-maintainers to help with reviews?

3. Automation: Could GitHub Actions help automate more of the review process (e.g., auto-merge dependency updates, automated test runs with results posted)?

📊 Overall Assessment

Verdict: ✅ Approve with suggestions

This is a reasonable change that sets realistic expectations. The suggestions above are optional improvements to balance transparency with community encouragement. The PR is technically sound and ready to merge as-is, though the tone adjustments might foster a more welcoming contributor experience.

---

Reviewed by: Claude Code (Sonnet 4.5)
Review Criteria: Code quality, best practices, project alignment, community impact

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 50.36%. Comparing base (07edcc4) to head (66c4e3c).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #100   +/-   ##
=======================================
  Coverage   50.36%   50.36%           
=======================================
  Files          99       99           
  Lines        5111     5111           
  Branches     1492     1492           
=======================================
  Hits         2574     2574           
  Misses       2291     2291           
  Partials      246      246           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.