From 35f9a1c2cb743d050e000cb8865a70240ce3ed6d Mon Sep 17 00:00:00 2001 From: Dimitri Benin Date: Sat, 31 Dec 2016 03:54:53 +0100 Subject: [PATCH] docs(developer): add linting section and correct command to verify API changes --- DEVELOPER.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/DEVELOPER.md b/DEVELOPER.md index 95136acc48..0b7e18d617 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -133,7 +133,8 @@ If you happen to modify the public API of Angular, API golden files must be upda $ gulp public-api:update ``` -Note: The command `./test.sh tools` fails when the API doesn't match the golden files. +Note: The command `gulp public-api:enforce` fails when the API doesn't match the golden files. Make sure to rebuild +the project before trying to verify after an API change. ## Formatting your source code @@ -146,6 +147,14 @@ You can automatically format your code by running: $ gulp format ``` +## Linting/verifying your source code + +You can check that your code is properly formatted and adheres to coding style by running: + +``` shell +$ gulp lint +``` + ## Publishing your own personal snapshot build You may find that your un-merged change needs some validation from external participants.