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
Copy file name to clipboardExpand all lines: CODE_OF_CONDUCT.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,20 +14,20 @@ appearance, race, religion, or sexual identity and orientation.
14
14
Examples of behavior that contributes to creating a positive environment
15
15
include:
16
16
17
-
* Use welcoming and inclusive language
18
-
* Respect each other
19
-
* Provide and gracefully accept constructive criticism
20
-
* Show empathy towards other community members
17
+
- Use welcoming and inclusive language
18
+
- Respect each other
19
+
- Provide and gracefully accept constructive criticism
20
+
- Show empathy towards other community members
21
21
22
22
Examples of unacceptable behavior by participants include:
23
23
24
-
* Trolling, insulting/derogatory comments, and personal or political attacks
25
-
* Public or private harassment
26
-
* Publishing others' private information, such as a physical or electronic
24
+
- Trolling, insulting/derogatory comments, and personal or political attacks
25
+
- Public or private harassment
26
+
- Publishing others' private information, such as a physical or electronic
27
27
address, without explicit permission
28
-
* The use of sexualized language or imagery
29
-
* Unwelcome sexual attention or advances
30
-
* Other conduct which could reasonably be considered inappropriate in a
28
+
- The use of sexualized language or imagery
29
+
- Unwelcome sexual attention or advances
30
+
- Other conduct which could reasonably be considered inappropriate in a
31
31
professional setting
32
32
33
33
## Our Responsibilities
@@ -69,9 +69,9 @@ members of the project's leadership.
69
69
70
70
If you are banned you may contest the decision. To do so email conduct@angular.io with the subject line "Repeal Ban for {{your name here}}" and body with the responses to the following:
71
71
72
-
* Why do you believe you did not violate the Code of Conduct?
73
-
* Were other factors involved in this situation the leadership team may have been unaware of?
74
-
* Why do you wish to be a part of the Angular community?
72
+
- Why do you believe you did not violate the Code of Conduct?
73
+
- Were other factors involved in this situation the leadership team may have been unaware of?
74
+
- Why do you wish to be a part of the Angular community?
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+63-73Lines changed: 63 additions & 73 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,22 +3,20 @@
3
3
We would love for you to contribute to Angular and help make it even better than it is today!
4
4
As a contributor, here are the guidelines we would like you to follow:
5
5
6
-
-[Code of Conduct](#coc)
7
-
-[Question or Problem?](#question)
8
-
-[Issues and Bugs](#issue)
9
-
-[Feature Requests](#feature)
10
-
-[Submission Guidelines](#submit)
11
-
-[Coding Rules](#rules)
12
-
-[Commit Message Guidelines](#commit)
13
-
-[Signing the CLA](#cla)
14
-
6
+
-[Code of Conduct](#coc)
7
+
-[Question or Problem?](#question)
8
+
-[Issues and Bugs](#issue)
9
+
-[Feature Requests](#feature)
10
+
-[Submission Guidelines](#submit)
11
+
-[Coding Rules](#rules)
12
+
-[Commit Message Guidelines](#commit)
13
+
-[Signing the CLA](#cla)
15
14
16
15
## <aname="coc"></a> Code of Conduct
17
16
18
17
Help us keep Angular open and inclusive.
19
18
Please read and follow our [Code of Conduct][coc].
20
19
21
-
22
20
## <aname="question"></a> Got a Question or Problem?
23
21
24
22
Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests.
@@ -34,28 +32,25 @@ To save your and our time, we will systematically close all issues that are requ
34
32
35
33
If you would like to chat about the question in real-time, you can reach out via [the Angular community Discord server][discord].
36
34
37
-
38
35
## <aname="issue"></a> Found a Bug?
39
36
40
37
If you find a bug in the source code, you can help us by [submitting an issue](#submit-issue) to our [GitHub Repository][github].
41
38
Even better, you can [submit a Pull Request](#submit-pr) with a fix.
42
39
43
-
44
40
## <aname="feature"></a> Missing a Feature?
45
-
You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub Repository.
46
-
If you would like to *implement* a new feature, please consider the size of the change in order to determine the right steps to proceed:
47
41
48
-
* For a **Major Feature**, first open an issue and outline your proposal so that it can be discussed.
42
+
You can _request_ a new feature by [submitting an issue](#submit-issue) to our GitHub Repository.
43
+
If you would like to _implement_ a new feature, please consider the size of the change in order to determine the right steps to proceed:
44
+
45
+
- For a **Major Feature**, first open an issue and outline your proposal so that it can be discussed.
49
46
This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
50
47
51
48
**Note**: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.
52
49
53
-
***Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
54
-
50
+
-**Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
55
51
56
52
## <aname="submit"></a> Submission Guidelines
57
53
58
-
59
54
### <aname="submit-issue"></a> Submitting an Issue
60
55
61
56
Before you submit an issue, please search the issue tracker. An issue for your problem might already exist and the discussion might inform you of workarounds readily available.
@@ -74,7 +69,6 @@ Unfortunately, we are not able to investigate / fix bugs without a minimal repro
74
69
75
70
You can file new issues by selecting from our [new issue templates](https://github.com/angular/angular/issues/new/choose) and filling out the issue template.
76
71
77
-
78
72
### <aname="submit-pr"></a> Submitting a Pull Request (PR)
79
73
80
74
Before you submit your Pull Request (PR) consider the following guidelines:
@@ -93,9 +87,9 @@ Before you submit your Pull Request (PR) consider the following guidelines:
93
87
94
88
5. In your forked repository, make your changes in a new git branch:
95
89
96
-
```shell
97
-
git checkout -b my-fix-branch main
98
-
```
90
+
```shell
91
+
git checkout -b my-fix-branch main
92
+
```
99
93
100
94
6. Create your patch, **including appropriate test cases**.
101
95
@@ -106,10 +100,11 @@ Before you submit your Pull Request (PR) consider the following guidelines:
106
100
9. Commit your changes using a descriptive commit message that follows our [commit message conventions][commit-message-guidelines].
107
101
Adherence to these conventions is necessary because release notes are automatically generated from these messages.
108
102
109
-
```shell
110
-
git commit --all
111
-
```
112
-
Note: the optional commit `--all`command line option will automatically "add" and "rm" edited files.
103
+
```shell
104
+
git commit --all
105
+
```
106
+
107
+
Note: the optional commit `--all` command line option will automatically "add" and "rm" edited files.
113
108
114
109
10. Push your branch to GitHub:
115
110
@@ -133,86 +128,84 @@ If we ask for changes via code reviews then:
133
128
134
129
3. Create a fixup commit and push to your GitHub repository (this will update your Pull Request):
135
130
136
-
```shell
137
-
git commit --all --fixup HEAD
138
-
git push
139
-
```
131
+
```shell
132
+
git commit --all --fixup HEAD
133
+
git push
134
+
```
140
135
141
-
For more info on working with fixup commits see [here](./contributing-docs/using-fixup-commits.md).
136
+
For more info on working with fixup commits see [here](./contributing-docs/using-fixup-commits.md).
142
137
143
138
That's it! Thank you for your contribution!
144
139
145
-
146
140
##### Updating the commit message
147
141
148
142
A reviewer might often suggest changes to a commit message (for example, to add more context for a change or adhere to our [commit message guidelines][commit-message-guidelines]).
149
143
In order to update the commit message of the last commit on your branch:
150
144
151
145
1. Check out your branch:
152
146
153
-
```shell
154
-
git checkout my-fix-branch
155
-
```
147
+
```shell
148
+
git checkout my-fix-branch
149
+
```
156
150
157
151
2. Amend the last commit and modify the commit message:
158
152
159
-
```shell
160
-
git commit --amend
161
-
```
153
+
```shell
154
+
git commit --amend
155
+
```
162
156
163
157
3. Push to your GitHub repository:
164
158
165
-
```shell
166
-
git push --force-with-lease
167
-
```
159
+
```shell
160
+
git push --force-with-lease
161
+
```
168
162
169
163
> NOTE:<br />
170
164
> If you need to update the commit message of an earlier commit, you can use `git rebase`in interactive mode.
171
165
> See the [git docs](https://git-scm.com/docs/git-rebase#_interactive_mode) for more details.
172
166
173
-
174
167
#### After your pull request is merged
175
168
176
169
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
177
170
178
-
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
171
+
- Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
179
172
180
-
```shell
181
-
git push origin --delete my-fix-branch
182
-
```
173
+
```shell
174
+
git push origin --delete my-fix-branch
175
+
```
183
176
184
-
* Check out the main branch:
177
+
- Check out the main branch:
185
178
186
-
```shell
187
-
git checkout main -f
188
-
```
179
+
```shell
180
+
git checkout main -f
181
+
```
189
182
190
-
* Delete the local branch:
183
+
- Delete the local branch:
191
184
192
-
```shell
193
-
git branch -D my-fix-branch
194
-
```
185
+
```shell
186
+
git branch -D my-fix-branch
187
+
```
195
188
196
-
* Update your local`main` with the latest upstream version:
197
-
198
-
```shell
199
-
git pull --ff upstream main
200
-
```
189
+
- Update your local`main` with the latest upstream version:
201
190
191
+
```shell
192
+
git pull --ff upstream main
193
+
```
202
194
203
195
## <a name="rules"></a> Coding Rules
204
-
To ensure consistency throughout the source code, keep these rules in mind as you are working:
205
196
206
-
* All features or bug fixes **must be tested** by one or more specs (unit-tests).
207
-
* All public API methods **must be documented**.
208
-
* We follow [Google's TypeScript Style Guide][ts-style-guide], but wrap all code at **100 characters**.
197
+
To ensure consistency throughout the source code, keep these rules in mind as you are working:
209
198
210
-
An automated formatter is available, see [building-and-testing-angular.md](./contributing-docs/building-and-testing-angular.md#formatting-your-source-code).
199
+
- All features or bug fixes **must be tested** by one or more specs (unit-tests).
200
+
- All public API methods **must be documented**.
201
+
- We follow [Google's TypeScript Style Guide][ts-style-guide], but wrap all code at **100 characters**.
211
202
203
+
An automated formatter is available, see [building-and-testing-angular.md](./contributing-docs/building-and-testing-angular.md#formatting-your-source-code).
We have very precise rules over how our Git commit messages must be formatted:
208
+
216
209
```
217
210
<type>(<scope>): <short summary>
218
211
```
@@ -224,21 +217,18 @@ See [Commit Message Guidelines][commit-message-guidelines] for details.
224
217
Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code
225
218
changes to be accepted, the CLA must be signed. It's a quick process, we promise!
226
219
227
-
* For individuals, we have a [simple click-through form][individual-cla].
228
-
* For corporations, we'll need you to
220
+
- For individuals, we have a [simple click-through form][individual-cla].
221
+
- For corporations, we'll need you to
229
222
[print, sign and one of scan+email, fax or mail the form][corporate-cla].
230
223
231
224
If you have more than one GitHub accounts, or multiple email addresses associated with a single GitHub account, you must sign the CLA using the primary email address of the GitHub account used to author Git commits and send pull requests.
232
225
233
226
The following documents can help you sort out issues with GitHub accounts and multiple email addresses:
Copy file name to clipboardExpand all lines: adev/README.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,13 +52,12 @@ pnpm bazel clean
52
52
pnpm bazel clean --expunge
53
53
```
54
54
55
-
56
-
## High level architecture
55
+
## High level architecture
57
56
58
57
The angular.dev website is a modern Angular application that utilizes Static Site Generation (SSG) to deliver pre-rendered, high-performance content to users.
59
58
60
59
The architecture is designed for efficiency and maintainability:
61
60
62
61
Content Sources: The documentation is sourced from two main places within the monorepo. The guides and tutorials are written in Markdown files, while the API reference pages are automatically generated by extracting documentation directly from the TypeScript source code of the Angular framework packages.
63
62
64
-
Build Process: During the build process, the Markdown files are converted into HTML. Simultaneously, the API documentation is extracted from the code comments. This content is then integrated into the Angular application.
63
+
Build Process: During the build process, the Markdown files are converted into HTML. Simultaneously, the API documentation is extracted from the code comments. This content is then integrated into the Angular application.
0 commit comments