Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (69 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

99 lines (69 loc) · 2.63 KB

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via Pull Requests on GitHub.

Pull Requests

  • PSR-12 Coding Standard - Check the code style with composer format.

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Running Tests

composer test

Code Style

We use Laravel Pint for code formatting:

composer format

Development Setup

  1. Fork the repository

  2. Clone your fork locally

  3. Run the setup script (recommended):

    ./setup.sh

    Or manually install dependencies:

    composer install

  4. Create a feature branch:

    git checkout -b feature/your-feature-name

  5. Make your changes

  6. Run tests:

    composer test

  7. Format code:

    composer format

  8. Commit and push

  9. Create a Pull Request

PHP Version Compatibility

This package supports:

  • PHP 8.1 with Laravel 10
  • PHP 8.2+ with Laravel 10 or 11

The setup.sh script automatically detects your PHP version and installs compatible dependencies.

Reporting Issues

When creating an issue, please provide:

  • PHP Version
  • Laravel Version
  • Filament Version
  • Package Version
  • Steps to reproduce
  • Expected behavior
  • Actual behavior

Feature Requests

We're always looking for suggestions to improve this package. If you have a suggestion, please:

  1. Check if the feature has already been requested
  2. Create a detailed issue explaining:
    • What problem it solves
    • How you envision it working
    • Any alternative solutions you've considered

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Happy coding!