Development Workflow of Project on Shopsys Platform¶
Requirements¶
- Shopsys Platform installed
- GIT repository created from Shopsys Platform project-base
How to develop a new feature¶
-
Create a new branch from
master
branch e.g.,my-new-feature
-
Develop your feature
-
Check and automatically fix your code standards using
php phing standards-fix-diff
Hint
In this step you were using Phing target
standards-fix-diff
.
More information about what Phing targets are and how they work can be found in Console Commands for Application Management (Phing Targets) -
Check if all tests are passing using
php phing tests
-
Run acceptance tests
php phing tests-acceptance
Tip
We suggest you running acceptance tests on your Continuous Integration server because it takes several minutes to run them.
-
Create commit with descriptive commit message about changes you have made.
Tip
We have Guidelines for Creating Commits for contributors to Shopsys Platform.
These guidelines suggest some best practices for creating commits that you could adopt on your project. -
Push changes to your remote GIT repository
-
Let some colleague review your code and fix all reported problems
Note
We pay a lot of attention to code quality in Shopsys company.
Apart from automatic testing and coding standards checks at least one of the colleagues reviews your code and another colleague tests changes whether they are working properly.
We found this practices very important and we suggest them to you as part of your development process. -
Rebase your branch on the current version of
master
branchNote
This leads to clean GIT history.
-
Merge your branch (e.g.,
my-new-feature
) intomaster
branch. -
Push
master
branch