You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update and reorganize contributor docs (angular#56141)
* Move from `docs/` to `contributing-docs/`
* Updated file names to better communicate their content
* Consolidated content into fewer docs
* Updated and/or deleted obsolete info
PR Closeangular#56141
Copy file name to clipboardExpand all lines: contributing-docs/building-and-testing-angular.md
+47-67
Original file line number
Diff line number
Diff line change
@@ -19,22 +19,27 @@ if you'd like to contribute to Angular.
19
19
## Prerequisite Software
20
20
21
21
Before you can build and test Angular, you must install and configure the
22
-
following products on your development machine:
22
+
following on your development machine:
23
23
24
-
*[Git](https://git-scm.com/) and/or the [**GitHub app**](https://desktop.github.com/) (for Mac and Windows);
25
-
[GitHub's Guide to Installing Git](https://help.github.com/articles/set-up-git) is a good source of information.\
24
+
*[Git](https://git-scm.com/) and/or the [**GitHub app**](https://desktop.github.com/) (for Mac and
25
+
Windows);
26
+
[GitHub's Guide to Installing Git](https://help.github.com/articles/set-up-git) is a good source
27
+
of information.\
26
28
**Windows Users**: Git Bash or an equivalent shell is required\
27
-
*Windows Powershell and cmd shells are not supported [#46780](https://github.com/angular/angular/issues/46780) so some commands might fail*
29
+
*Windows Powershell and cmd shells are not
30
+
supported [#46780](https://github.com/angular/angular/issues/46780) so some commands might fail*
28
31
29
-
*[Node.js](https://nodejs.org), (version specified in [`.nvmrc`](../.nvmrc)) which is used to run a development web server,
32
+
*[Node.js](https://nodejs.org), (version specified in [`.nvmrc`](../.nvmrc)) which is used to run a
33
+
development web server,
30
34
run tests, and generate distributable files.
31
-
`.nvmrc` is read by [nvm](https://github.com/nvm-sh/nvm) commands like `nvm install` and `nvm use`.
35
+
`.nvmrc` is read by [nvm](https://github.com/nvm-sh/nvm) commands like `nvm install`
36
+
and `nvm use`.
32
37
33
-
*[Yarn](https://yarnpkg.com) (version specified in the engines field of [`package.json`](../package.json)) which is used to install dependencies.
38
+
*[Yarn](https://yarnpkg.com) (version specified in the engines field
39
+
of [`package.json`](../package.json)) which is used to install dependencies.
34
40
35
-
* On Windows: [MSYS2](https://www.msys2.org/) which is used by Bazel. Follow the [instructions](https://bazel.build/install/windows#installing-compilers-and-language-runtimes)
36
-
37
-
* Optional: [Java](https://openjdk.java.net/) version 7 or higher than required by [Closure Compiler](https://developers.google.com/closure/compiler). Most developers will not need this. Java is required for running some integration tests.
41
+
* On Windows: [MSYS2](https://www.msys2.org/) which is used by Bazel. Follow
42
+
the [instructions](https://bazel.build/install/windows#installing-compilers-and-language-runtimes)
38
43
39
44
## Getting the Sources
40
45
@@ -81,15 +86,18 @@ yarn build
81
86
82
87
Bazel is used as the primary tool for building and testing Angular.
83
88
84
-
To see how to run and debug Angular tests locally please refer to the Bazel [Testing Angular](./BAZEL.md#testing-angular) section.
89
+
To see how to run and debug Angular tests locally please refer to the
Note that you should execute all test suites before submitting a PR to GitHub (`yarn test //packages/...`).
92
+
Note that you should execute all test suites before submitting a PR to
93
+
GitHub (`yarn test //packages/...`).
87
94
88
-
However, affected tests will be executed on our CI infrastructure. So if you forgot to run some affected tests which would fail, GitHub will indicate the error state and present you the failures.
95
+
However, affected tests will be executed on our CI infrastructure. So if you forgot to run some
96
+
affected tests which would fail, GitHub will indicate the error state and present you the failures.
89
97
90
98
PRs can only be merged if the code is formatted properly and all tests are passing.
91
99
92
-
<aname="formatting-your-source-code">
100
+
<aname="formatting-your-source-code"></a>
93
101
<aname="clang-format"></a>
94
102
<aname="prettier"></a>
95
103
@@ -100,6 +108,7 @@ use changes in another library or project. To do this developers can build Angul
100
108
using `yarn link` build a local project with the created artifacts.
When making changes to Angular packages and testing in a local library/project you need to run `ng cache disable` to disable the Angular CLI disk cache. If you are making changes that are not reflected in your locally served library/project, verify if you have [CLI Cache](https://angular.io/guide/workspace-config#cache-options) disabled.
120
+
When making changes to Angular packages and testing in a local library/project you need to
121
+
run `ng cache disable` to disable the Angular CLI disk cache. If you are making changes that are not
122
+
reflected in your locally served library/project, verify if you
123
+
have [CLI Cache](https://angular.io/guide/workspace-config#cache-options) disabled.
112
124
113
125
#### Invoking the Angular CLI
114
126
115
-
The Angular CLI needs to be invoked using Node.js [`--preserve-symlinks`](https://nodejs.org/api/cli.html#--preserve-symlinks) flag. Otherwise the symbolic links will be resolved using their real path which causes node module resolution to fail.
0 commit comments