How to contribute

Thanks for considering to contribute to llms-txt-php.

Setting up a development environment

To set up a development environment, please follow the next shown instructions.

git clone git@github.com:raphaelstolt/llms-txt-php.git
composer install
// implement your changes
composer pre-commit-check

Please follow these guidelines when sending changes upstream:

• All code MUST follow the PSR-2 coding standard. Please see PSR-2 for more details.

• Coding standard compliance MUST be ensured before committing or opening pull requests by running composer cs-fix or composer cs-lint in the root directory of this repository.

• Commits MUST follow the Conventional Commits conventions.

• All upstreamed contributions MUST use feature / topic branches to ease merging.

• Please run composer pre-commit-check before opening a pull request.