- Push to the master branch directly is restricted.
- Use feature branches and let people discuss changes in pull requests.
- Pull requests can only be merged after all discussions have been concluded and 2 reviewers have given theirs approval (:+1:)
- Create an issue and describe your idea (remember its number)
- Create your feature branch:
git checkout -b <issue-NUMBER> - Commit your changes:
git commit -am 'Add some feature' - Publish the branch:
git push origin issue-NUMBER - Create a new Pull Request
- Every change needs a test (fortunately codecov.io keeps code coverage metric)
- Keep the code style by resolving SwiftLint warnings
- Commit message must be in the following format:
#<issue_number>: <body>
Main frameworks (ZalandoCommerceAPI and ZalandoCommerceUI) have strict rule to do not depend on any external library.
In some exceptional cases it could be lifted, but you should always first consider copying source code from the external framework instead (and the best – not whole, but just needed part).
Rationale behind is:
- Don't force end-developers to use additional libraries. It makes their app fatter and harder to maintain, as it could also lead to conflicts with their own dependencies
- A small piece of code which does the job well is easier in maintenance than coupling to external library, which could change a lot
- Not updated library may introduce risk of having it not fixed or updated if it loose a maintainer
- Updating unmaintained the whole external library (eg. for new Swift version) on your own could be time consuming
- And in general, not only on framework level: the less dependencies, the higher reuse factor.
They're totally allowed in satellite projects (MockAPI or ZalandoCommerceDemoApp), however the less we have them, the simpler maintanance and updating is.
For this purpose we use Carthage. calypso.rb has an appropriate task for it:
brew install carthage
./calypso.rb deps build