|
| 1 | +# FlightPHP/Core Project Instructions |
| 2 | + |
| 3 | +## Overview |
| 4 | +This is the main FlightPHP core library for building fast, simple, and extensible PHP web applications. It is dependency-free for core usage and supports PHP 7.4+. |
| 5 | + |
| 6 | +## Project Guidelines |
| 7 | +- PHP 7.4 must be supported. PHP 8 or greater also supported, but avoid PHP 8+ only features. |
| 8 | +- Keep the core library dependency-free (no polyfills or interface-only repositories). |
| 9 | +- All Flight projects are meant to be kept simple and fast. Performance is a priority. |
| 10 | +- Flight is extensible and when implementing new features, consider how they can be added as plugins or extensions rather than bloating the core library. |
| 11 | +- Any new features built into the core should be well-documented and tested. |
| 12 | +- Any new features should be added with a focus on simplicity and performance, avoiding unnecessary complexity. |
| 13 | +- This is not a Laravel, Yii, Code Igniter or Symfony clone. It is a simple, fast, and extensible framework that allows you to build applications quickly without the overhead of large frameworks. |
| 14 | + |
| 15 | +## Development & Testing |
| 16 | +- Run tests: `composer test` (uses phpunit/phpunit and spatie/phpunit-watcher) |
| 17 | +- Run test server: `composer test-server` or `composer test-server-v2` |
| 18 | +- Lint code: `composer lint` (uses phpstan/phpstan, level 6) |
| 19 | +- Beautify code: `composer beautify` (uses squizlabs/php_codesniffer, PSR1) |
| 20 | +- Check code style: `composer phpcs` |
| 21 | +- Test coverage: `composer test-coverage` |
| 22 | + |
| 23 | +## Coding Standards |
| 24 | +- Follow PSR1 coding standards (enforced by PHPCS) |
| 25 | +- Use strict comparisons (`===`, `!==`) |
| 26 | +- PHPStan level 6 compliance |
| 27 | +- Focus on PHP 7.4 compatibility (avoid PHP 8+ only features) |
0 commit comments