From 44ff005ce3c3b697eff5148d816cf46c18313ad2 Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Thu, 14 Jul 2016 08:51:05 -0700 Subject: [PATCH] doc(developer): updates (#10075) --- DEVELOPER.md | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) diff --git a/DEVELOPER.md b/DEVELOPER.md index 3a1782e27e..6085ac6cf6 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -134,7 +134,39 @@ To build Angular run: To run tests: ```shell -./test.sh node -./test.sh browser -./test.sh tools +$ ./test.sh node + +$ ./test.sh browser + +$ ./test.sh tools ``` + +You should execute the 3 test suites before submitting a PR to github. + +All the tests are executed on our Continuous Integration infrastructure and a PR could only be merged once the tests pass. + +- CircleCI fails if your code is not formatted properly, +- Travis CI fails if any of the test suite describe above fails. + +## Update the public API tests + +If you happen to modify the public API of Angular, API golden files must be updated using: + +``` shell +$ gulp public-api:update +``` + +Note: The command `./test.sh tools` fails when the API doesn't match the golden files. + +## Formatting your source code + +Angular uses [clang-format](http://clang.llvm.org/docs/ClangFormat.html) to format the source code. If the source code +is not properly formatted, the CI will fail and the PR can not be merged. + +You can automatically format your code by running: + +``` shell +$ gulp format +``` + +