Skip to content

docs: add Contributing section to README - #473

Merged
baleen37 merged 1 commit into
mainfrom
chore/readme-contributing-section
Feb 10, 2026
Merged

docs: add Contributing section to README#473
baleen37 merged 1 commit into
mainfrom
chore/readme-contributing-section

Conversation

@baleen37

@baleen37 baleen37 commented Feb 10, 2026

Copy link
Copy Markdown
Owner

Summary

Add Contributing section to README.md to clarify contribution guidelines.

Changes

  • Added new "Contributing" section before the License section
  • Outlines 4 key contribution requirements:
    • Conventional Commits format using bun run commit
    • Pre-commit hooks compliance
    • BATS test coverage for new features
    • Documentation updates for plugin changes

Test plan

  • All pre-commit hooks pass
  • All BATS tests pass locally
  • CI / test workflow passes on PR

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated README with contributing guidelines covering conventional commit conventions, pre-commit hooks, test coverage requirements, and documentation standards.

Add Contributing section to README.md to clarify contribution guidelines including Conventional Commits, pre-commit hooks, test coverage, and documentation requirements.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@baleen37
baleen37 enabled auto-merge February 10, 2026 03:11
@coderabbitai

coderabbitai Bot commented Feb 10, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The PR adds two Contributing sections to README.md documenting development conventions including Conventional Commits, pre-commit hooks, test coverage expectations, and documentation requirements. These are purely informational additions with no code changes or behavioral modifications.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added Contributing sections (appearing in two locations) outlining workflow conventions: Conventional Commits format, pre-commit hook setup, test coverage requirements, and documentation standards.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 With whiskers twitched and carrots nibbled fine,
I've helped you chart a contributing line—
Commits conventional, pre-commits to test,
Now developers know how to do their best! 🥕✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/readme-contributing-section

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.

@baleen37
baleen37 merged commit c02cdcf into main Feb 10, 2026
4 of 5 checks passed
@baleen37
baleen37 deleted the chore/readme-contributing-section branch February 10, 2026 03:13
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