Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.48 KB

File metadata and controls

24 lines (16 loc) · 1.48 KB

Generation Tux Development Standards

Code

  • Must follow all accepted PSR styling standards.
  • Must follow SOLID principles. (Ask an engineer for Laracast credentials.)
  • Must go through code review and be approved by a fellow engineering before being pulled into mainline branches.
  • Should be readable to indicate what is happening, and comments should indicate why.

Code Review

Reviewers must verify the standards in this document are being followed in addition to other code review best practices.

  • Must be reviewed by the author first.
  • Must be reviewed by at least one other member of the team (crucial for knowledge sharing).

Testing

A developer should be able to check out the project, make a change, and if the tests pass, be confident their change can be deployed to production.

  • Tests should be automated to run in a CI environment on every pull request.
  • Requirements for a feature should be scoped out by the team prior to beginning work on that feature.
  • Unit test coverage should be 100% for domain logic, leaving integration points with the framework (such as controllers, service providers, etc.) to be covered by other types of tests described below.
  • Functional, integration and acceptance testing coverage should be whatever it needs to be to ensure the application is working correctly.