Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.51 KB

File metadata and controls

38 lines (26 loc) · 1.51 KB

Contributing to Acara Plate

Thank you for considering contributing to Acara Plate! The contribution guide helps you understand how to contribute to the project.

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Getting Started

  1. Fork the repository.
  2. Clone your fork: git clone https://github.com/your-username/plate.git
  3. Create a new branch: git checkout -b feature/my-feature
  4. Install dependencies: composer setup
  5. Make your changes.
  6. Run tests: composer test
  7. Commit your changes: git commit -m "Add some feature"
  8. Push to the branch: git push origin feature/my-feature
  9. Submit a pull request.

Coding Standards

  • PHP: We follow PSR-12 coding standards. We use Laravel Pint to fix code style issues. Run composer lint before committing.
  • JavaScript/TypeScript: We use ESLint and Prettier. Run npm run lint to check for issues.
  • Tests: Please ensure all tests pass. We use Pest for testing.

Reporting Bugs

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).

Security Vulnerabilities

If you discover a security vulnerability within Acara Plate, please send an email to the maintainers instead of using the issue tracker.