We are working on a framework, is mandatory that you have read the framework doc:
We use PHP you should know what is php-fig
-
Tvision Style is "No frills"
-
Simple-Clean-Rude-This-Week is always better than
Complex-NextMonth and Perfect-Never too.
-
Clean
-
We strictly follow the Symfony coding standard.
-
Without debugging comments eg. //echo
-
The variable name should replace the comment see book clean code (this book is in our library).
-
Only the English language exists in the code.
-
Follow the Object Oriented extreme philosophy.
-
If you wrote code with too much "if-else", maybe you didn't follow correctly the step n#6.
-
Event and Logger are good friends.
-
Exceptions are very good friends.
-
Dependency Injection
-
Design Patterns.
-
BEST PRACTICE.
-
Test before coding
We use the git-flow standard naming convention and branching model http://nvie.com/posts/a-successful-git-branching-model/
create a branch name for each task
Follow this pattern
-
[use case list] Get a task from the use case list.
-
[develop] Develop on your repo (using a branch for every task)
-
[git] Push to your fork whenever you want (also with broken tests)
-
[test+git] Pull from upstream when your task is complete and all the tests are green
-
[test] Check that the tests are still green
-
[git] Make a Pull Request
-
[use case list] Flag the task in the use case list as Waiting Quality Assurance.