Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (29 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) · 1.23 KB

Contributing to Laravel Page Speed

Thank you for considering contributing to Laravel Page Speed! We welcome contributions via Pull Requests on GitHub.

📋 Quick Guidelines

  • Follow PSR-2 - Check code style with composer check-style and fix with composer fix-style
  • Add tests - Your patch won't be accepted without tests
  • Update documentation - Keep README.md and relevant docs up-to-date
  • Follow SemVer - We follow Semantic Versioning
  • Use feature branches - Branch from develop, not master
  • One PR per feature - Keep changes focused
  • Clean commit history - Use meaningful commit messages

🔄 Development Workflow

We follow Git Flow. Please read GIT_FLOW.md for detailed workflow.

Quick Start

  1. Fork the repository
  2. Create feature branch from develop: 
    git checkout develop
git checkout -b feature/my-feature
  3. Make changes and add tests
  4. Ensure tests pass: composer test
  5. Check code style: composer check-style
  6. Commit with conventional commits format
  7. Push and create PR targeting develop

🧪 Running Tests

$ composer test

Happy coding!
⚡