Skip to content

fix(Contributing): Reference CONTRIBUTING file from README - #304

Merged
piotrzajac merged 1 commit into
masterfrom
fix/reference-CONTRIBUTING-from-README
Apr 8, 2026
Merged

fix(Contributing): Reference CONTRIBUTING file from README#304
piotrzajac merged 1 commit into
masterfrom
fix/reference-CONTRIBUTING-from-README

Conversation

@piotrzajac

@piotrzajac piotrzajac commented Apr 8, 2026

Copy link
Copy Markdown
Collaborator

Summary

Reference CONTRIBUTING file from README

Checklist

  • Commit messages follow Conventional Commits (type(scope): description)
  • dotnet build src/Objectivity.AutoFixture.XUnit2.AutoMock.sln passes with no warnings
  • dotnet test src/Objectivity.AutoFixture.XUnit2.AutoMock.sln passes on all framework slices
  • Code coverage remains at least at the level prior the change (verified by Codecov)
  • Mutation score remains at least at the level prior the change (verified by Stryker)
  • New tests follow the GIVEN/WHEN/THEN naming convention and AAA structure (see AGENTS.md)
  • No new [SuppressMessage] without a justification comment
  • No // TODO: comments added — open a GitHub issue instead
  • No new dependencies introduced that are incompatible with the MIT license (verified by FOSSA)

@coderabbitai

coderabbitai Bot commented Apr 8, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Updated the README.md "Contributing" section to direct readers toward CONTRIBUTING.md for setup and workflow details, while instructing AI coding assistants to reference AGENTS.md for project context and architecture guidelines.

Changes

Cohort / File(s) Summary
Documentation
README.md
Updated Contributing section to reference CONTRIBUTING.md and AGENTS.md for contributor guidance and AI assistant context.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

🐰 A README refreshed, so clean and bright,
With pointers placed to guide just right,
To CONTRIBUTING paths and AGENTS' ways,
This rabbit hops through clearer days!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description is minimal and lacks context. While it contains a complete checklist, it provides no summary of the issue or link to the relevant GitHub issue. Add a clear summary explaining why the CONTRIBUTING file reference is being added to README, and include a link to the related GitHub issue (e.g., 'Closes #XXX').
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title directly reflects the main change: updating README to reference the CONTRIBUTING file, which aligns with the file-level summary and PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/reference-CONTRIBUTING-from-README

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.

@piotrzajac
piotrzajac merged commit 08bc171 into master Apr 8, 2026
1 check was pending
@piotrzajac
piotrzajac deleted the fix/reference-CONTRIBUTING-from-README branch April 8, 2026 08:28
@coderabbitai coderabbitai Bot mentioned this pull request Apr 10, 2026
9 tasks
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