Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 1.84 KB

File metadata and controls

52 lines (36 loc) · 1.84 KB

Contributing to Warden

Thank you for considering contributing to Warden! We welcome contributions from the community to help make this package better.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:

  • A clear and descriptive title
  • Detailed steps to reproduce the issue
  • The expected behavior
  • The actual behavior
  • Your environment details (PHP version, Laravel version, etc.)

Suggesting Enhancements

If you have ideas for new features or improvements:

  • Use a clear and descriptive title
  • Provide a detailed description of the proposed feature
  • Explain why this enhancement would be useful
  • Consider how it might impact existing users

Pull Requests

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run the tests if applicable
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Warden targets PHP 8.3–8.5 and Laravel 12–13. New behavior must work across that declared compatibility matrix.

Pull Request Guidelines

  • Follow the existing code style and conventions
  • Update documentation as needed
  • Add tests for new features
  • Ensure composer test, composer phpstan, composer rector, and composer validate --strict pass
  • Preserve the documented exit-code and machine-report contracts
  • Use stable finding IDs and include remediation for every new rule
  • Keep pull requests focused - one feature/fix per PR

Have fun, and thank you for your contribution.