Thank you for considering contributing to Acara Plate! The contribution guide helps you understand how to contribute to the project.
This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.
- Fork the repository.
- Clone your fork:
git clone https://github.com/your-username/plate.git - Create a new branch:
git checkout -b feature/my-feature - Install dependencies:
composer setup - Make your changes.
- Run tests:
composer test - Commit your changes:
git commit -m "Add some feature" - Push to the branch:
git push origin feature/my-feature - Submit a pull request.
- PHP: We follow PSR-12 coding standards. We use Laravel Pint to fix code style issues. Run
composer lintbefore committing. - JavaScript/TypeScript: We use ESLint and Prettier. Run
npm run lintto check for issues. - Tests: Please ensure all tests pass. We use Pest for testing.
If you find a bug, please open an issue on GitHub. Include as much detail as possible, such as:
- Steps to reproduce the issue.
- Expected behavior.
- Actual behavior.
- Screenshots (if applicable).
If you discover a security vulnerability within Acara Plate, please send an email to the maintainers instead of using the issue tracker.