Skip to content

Improve CONTRIBUTING.md documentation#593

Open
fain182 wants to merge 2 commits intomainfrom
claude/update-contributing-md-VlcrN
Open

Improve CONTRIBUTING.md documentation#593
fain182 wants to merge 2 commits intomainfrom
claude/update-contributing-md-VlcrN

Conversation

@fain182
Copy link
Collaborator

@fain182 fain182 commented Mar 10, 2026

Summary

This PR improves the CONTRIBUTING.md file with better organization, clearer instructions, and corrected grammar. The documentation now provides a more structured guide for setting up the development environment both locally and with Docker.

Notable Details

The changes maintain all existing functionality while making the contribution process more accessible to new developers. The documentation now clearly separates local and Docker-based development workflows, making it easier for contributors to choose their preferred setup method.

https://claude.ai/code/session_01CSKtAMgtepUahGCezKbrgs

claude added 2 commits March 10, 2026 21:59
- Fix typo ("highlihting" → "highlighting") and grammar issues
- Add PHP version requirement (^8.0)
- Document available Makefile targets (test, csfix, psalm, build)
- Reorganize with clearer sections for Docker and local development

https://claude.ai/code/session_01CSKtAMgtepUahGCezKbrgs
Local development is now presented as the primary workflow, with Docker
as an alternative for those who prefer not to install PHP locally.

https://claude.ai/code/session_01CSKtAMgtepUahGCezKbrgs
@codecov
Copy link

codecov bot commented Mar 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.12%. Comparing base (88ddf78) to head (ac4a22c).

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #593   +/-   ##
=========================================
  Coverage     98.12%   98.12%           
  Complexity      663      663           
=========================================
  Files            84       84           
  Lines          1923     1923           
=========================================
  Hits           1887     1887           
  Misses           36       36           

☔ 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.

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.

2 participants