PHP Package Template

A repository template for Studio 24's open source PHP packages.

How to use this template

This package can be used as to scaffold a PHP package. Follow these steps to get started:

1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton
2. Run php ./configure.php to run a script that will replace all placeholders throughout all the files
3. Have fun creating your package.

Components

A brief explanation of the different components of this package template.

• .github/ISSUE_TEMPLATE - GitHub issue templates
• .github/workflows - GitHub actions for running tests (php.yml) and automated releases (release.yml)
• .github/dependabot.yml - Dependabot configuration
• src/ - The PHP source code for your package, this will autoload based on the autoload rules in composer.json
• tests - PHPUnit tests for your package
• .editorconfig - Your editor coding style configuration
• .gitattributes - Ignore these files/folders when this package is installed via Composer
• .phpcs.xml.dist - PHPCodeSniffer configuration
• .phplint.yml - PHPLint configuration
• CHANGELOG.md - A list of notable changes, the contents of this file are automated by automated releases
• CODE_OF_CONDUCT.md - Contributor's code of conduct
• composer.json - Composer PHP package dependencies
• configure.php - Package configuration script, this file is deleted once run
• CONTRIBUTING.md - Guide to contributing
• LICENSE.md - License information
• phpstan.neon - PHPStan configuration
• phpunit.xml.dist - PHPUnit configuration
• README.md - This README file, this file is deleted once configure.php is run
• README_DEFAULT.md - The default README file for your new package
• SECURITY.md - Security policy for this package

License

The MIT License (MIT). Please see License File for more information.

Thanks to

• Spatie Package Skeleton for inspiration on package organisation and the PHP configure script