Skip to content

docs: Add comprehensive contributing guide and update README#69

Merged
edevsh merged 1 commit into1.xfrom
docs/add-contributing-guide
Jul 18, 2025
Merged

docs: Add comprehensive contributing guide and update README#69
edevsh merged 1 commit into1.xfrom
docs/add-contributing-guide

Conversation

@edevsh
Copy link
Owner

@edevsh edevsh commented Jul 18, 2025

Summary

  • Added comprehensive CONTRIBUTING.md with detailed contribution guidelines
  • Updated README.md with quick start guide, requirements, and testing instructions
  • Improved project documentation for better contributor experience

Changes Made

  • CONTRIBUTING.md: New comprehensive guide covering:

    • PSR standards and SOLID principles
    • Development setup and workflow
    • Testing requirements and guidelines
    • Code quality standards
    • Pull request process
    • Project architecture overview
  • README.md: Enhanced with:

    • Quick start installation and usage examples
    • Clear requirements section
    • Testing commands and static analysis
    • Proper contributing section with links to new guide

Test Plan

  • Verify all markdown formatting renders correctly
  • Confirm all links work properly
  • Ensure documentation aligns with project structure
  • Test example code snippets for accuracy

- Add CONTRIBUTING.md with detailed contribution guidelines
- Include PSR standards, SOLID principles, and clean architecture requirements
- Add development setup, testing, and code quality sections
- Update README.md with quick start guide, requirements, and testing instructions
- Improve contributing section with proper links and guidelines
@edevsh edevsh self-assigned this Jul 18, 2025
@edevsh edevsh added the documentation Improvements or additions to documentation label Jul 18, 2025
@edevsh edevsh merged commit d95f743 into 1.x Jul 18, 2025
5 checks passed
@edevsh edevsh deleted the docs/add-contributing-guide branch July 18, 2025 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant