From 4a2cc3e451b4d073ef542467d6c9df4c54a4ad41 Mon Sep 17 00:00:00 2001 From: Joey Perrott Date: Tue, 25 May 2021 10:15:13 -0700 Subject: [PATCH] docs: add explanation of how to use locally created build artifacts in a local project (#42319) Add explanation of using `ng-dev build-and-link` to test local changes in another project. Closes #39719 PR Close #42319 --- docs/DEVELOPER.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/DEVELOPER.md b/docs/DEVELOPER.md index eacaaac854..d2ee7f542e 100644 --- a/docs/DEVELOPER.md +++ b/docs/DEVELOPER.md @@ -93,6 +93,17 @@ merged if the code is formatted properly and all tests are passing. +### Testing changes against a local library/project + +Often for developers the best way to ensure the changes they have made work as expected is to run +use changes in another library or project. To do this developers can build Angular locally, and +using `yarn link` build a local project with the created artifacts. + +This can be done by running: +```sh +yarn ng-dev build-and-link +``` + ## Formatting your source code Angular uses [clang-format](https://clang.llvm.org/docs/ClangFormat.html) to format the source code.