- Code style must follow PSR-1, PSR-2 and PSR-12.
- a file suffix should be sufficient to know what it does for instance an Exception class should have Exception as it suffix, a service class should have Service as it suffix, a Command class should have Command as it suffix.
- All Service classes must be well tested with tests for all their public methods defined in the tests/Unit directory.
- Command classes must be well tested with tests placed in the tests/Feature directory.
- app/Services directory is where Service classes are placed. Ideally complex tasks are not expected to be completely run in the console classes. Service classes are created so the console classes primary handle input and output.
- Doc blocks should only be used when they are required to give better context of the method or class. We believe that using clear and concise class and variable names with proper arguments and return type declaration should suffice. If a method returns nothing, then it return type must be declared as void.
- api endpoints in the Client class are defined as class properties while methods that fetch resources from the api should have the get prefix. Such method should also be clear on what resource it is fetching.
- Our coding guideline is also inspired by spatie coding guideline. You should check it out.