|
| 1 | +# Repository Guidelines for AI Contributors |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +This repository contains the core package for building microservices using Laravel. Code follows PSR-12 standards and is tested via PHPUnit. All pull requests must maintain test coverage and documentation. |
| 6 | + |
| 7 | +## Local Setup |
| 8 | + |
| 9 | +1. Install dependencies with `composer install`. |
| 10 | +2. Run the test suite with `composer test`. |
| 11 | +3. Check code style using `composer run print-test` and fix issues with `composer run print`. |
| 12 | + |
| 13 | +## Commit Messages |
| 14 | + |
| 15 | +- Use short, present-tense summaries (max 72 characters). |
| 16 | +- Include a blank line followed by a more detailed explanation when needed. |
| 17 | +- Reference related issues in the body (`Fixes #123`). |
| 18 | + |
| 19 | +## Pull Request Requirements |
| 20 | + |
| 21 | +1. Ensure the test suite passes (`composer test`). |
| 22 | +2. Ensure PSR-12 style (`composer run print-test`). |
| 23 | +3. Document notable changes in `CHANGELOG.md` when releasing a new version. |
| 24 | +4. Update relevant sections of `README.md` if behavior or public APIs change. |
| 25 | +5. Provide a clear PR description summarizing what changed and why. |
| 26 | + |
| 27 | +## Code Style |
| 28 | + |
| 29 | +- PSR-12 is enforced using Laravel Pint. |
| 30 | +- Use typed properties and return types when possible. |
| 31 | +- Keep methods small and focused. |
| 32 | +- Avoid introducing new global helpers or facades. |
| 33 | + |
| 34 | +## Directory Structure |
| 35 | + |
| 36 | +- `src/` contains the package source code. |
| 37 | +- `tests/` contains PHPUnit tests. |
| 38 | +- `vendor/` should not be committed. |
| 39 | + |
| 40 | +## Additional Notes |
| 41 | + |
| 42 | +- Keep pull requests small and focused to ease review. |
| 43 | +- Prefer expressive naming and add comments where logic is complex. |
| 44 | +- Any new feature should include corresponding tests. |
0 commit comments