coding-guidelines.md

Coding guidelines

[Back to readme]

This documentation is a work in progress. Contributions are not only welcome, but needed as well.

• Naming conventions

  • General naming conventions
  • Branch naming
  • Commit message naming

• Project structure and file organization

  • Backend structure
  • Frontend structure

• PHP coding standards

  • Syntax and style
  • Comment rules

• Routing conventions

  • API Route convention guide
  • Model binding

• Database and ORM conventions

  • Eloquent conventions
  • Eloquent relationships
  • Model binding
  • Migrations and schema conventions
  • Factory conventions

• Validation

  • FormRequest validation best practices

• Error handling

  • Error handling best practices

• Testing conventions

  • General guideline
  • Avoid Testing Laravel's Native Features
  • Creating tests
  • Code coverage

• Front-end conventions

• API design standards

  • Organization and versioning of endpoints
  • API response conventions
  • Standardization in error responses and error messages

• Security guidelines

• Documentation Standards

• Localization