Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (23 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 1.54 KB
Raw

Contributing

Contributions are welcome. If you want to ask or propose something, please create an issue. If you want to contribute, please send in a pull request.

⤴️ Pull requests

Make sure to follow these rules when creating a pull request:

  • Follow the PSR-12 coding standards (though we have a PHP CS Fixer workflow in place that takes care of that for you)
  • Write tests for new functionality or bug fixes and make sure test coverage is on point
  • Keep the README file and docs up-to-date with changes
  • We follow Semantic Versioning, so please send pull requests to the correct branch
  • Update the CHANGELOG.md file with any changes/additions/... and follow the changelog standards

🏃‍➡️ Running locally

This project is fully Dockerized, meaning Docker (or Orbstack for macOS users) is the only requirement to run this project locally. Using Docker Compose, we set up a container for each supported PHP version.

Tip

While you can run Docker Compose commands directly, we highly recommend to use our predefined tasks using Task. All docs will always refer to these tasks, but if you prefer not to install Task, you can inspect Taskfile.yml to see which Docker Compose commands are used under the hood.

To explore all available tasks, run:

task