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
The following are canned responses that the Angular CLI team should use to close issues on our issue tracker that fall into the listed resolution categories.
4
+
5
+
Since GitHub currently doesn't allow us to have a repository-wide or organization-wide list of [saved replies](https://help.github.com/articles/working-with-saved-replies/), these replies need to be maintained by individual team members. Since the responses can be modified in the future, all responses are versioned to simplify the process of keeping the responses up to date.
6
+
7
+
8
+
## Angular CLI: Already Fixed (v1)
9
+
```
10
+
Thanks for reporting this issue. Luckily, it has already been fixed in one of the recent releases. Please update to the most recent version to resolve the problem.
11
+
12
+
If the problem persists in your application after upgrading, please open a new issue, provide a simple repository reproducing the problem, and describe the difference between the expected and current behavior. You can use `ng new repro-app` to create a new project where you reproduce the problem.
13
+
```
14
+
15
+
## Angular CLI: Don't Understand (v1)
16
+
```
17
+
I'm sorry, but we don't understand the problem you are reporting.
18
+
19
+
If the problem persists, please open a new issue, provide a simple repository reproducing the problem, and describe the difference between the expected and current behavior. You can use `ng new repro-app` to create a new project where you reproduce the problem.
20
+
```
21
+
22
+
23
+
## Angular CLI: Duplicate (v1)
24
+
```
25
+
Thanks for reporting this issue. However, this issue is a duplicate of an existing issue #<ISSUE_NUMBER>. Please subscribe to that issue for future updates.
26
+
```
27
+
28
+
29
+
## Angular CLI: Insufficient Information Provided (v1)
30
+
```
31
+
Thanks for reporting this issue. However, you didn't provide sufficient information for us to understand and reproduce the problem. Please check out [our submission guidelines](https://github.com/angular/angular-cli/blob/master/CONTRIBUTING.md#-submitting-an-issue) to understand why we can't act on issues that are lacking important information.
32
+
33
+
If the problem persists, please file a new issue and ensure you provide all of the required information when filling out the issue template.
34
+
```
35
+
36
+
## Angular CLI: Issue Outside of Angular CLI (v1)
37
+
```
38
+
I'm sorry, but this issue is not caused by Angular CLI. Please contact the author(s) of project <PROJECT NAME> or file issue on their issue tracker.
39
+
```
40
+
41
+
42
+
## Angular CLI: Non-reproducible (v1)
43
+
```
44
+
I'm sorry, but we can't reproduce the problem following the instructions you provided.
45
+
46
+
If the problem persists, please open a new issue following [our submission guidelines](https://github.com/angular/angular-cli/blob/master/CONTRIBUTING.md#-submitting-an-issue).
47
+
```
48
+
49
+
## Angular CLI: Obsolete (v1)
50
+
```
51
+
Thanks for reporting this issue. This issue is now obsolete due to changes in the recent releases. Please update to the most recent Angular CLI version.
52
+
53
+
If the problem persists after upgrading, please open a new issue, provide a simple repository reproducing the problem, and describe the difference between the expected and current behavior.
54
+
```
55
+
56
+
57
+
## Angular CLI: Support Request (v1)
58
+
```
59
+
Hello, we reviewed this issue and determined that it doesn't fall into the bug report or feature request category. This issue tracker is not suitable for support requests, please repost your issue on [StackOverflow](http://stackoverflow.com/) using tag `angular-cli`.
60
+
61
+
If you are wondering why we don't resolve support issues via the issue tracker, please [check out this explanation](https://github.com/angular/angular-cli/blob/master/CONTRIBUTING.md#-got-a-question-or-problem).
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28-22Lines changed: 28 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,17 @@ Help us keep Angular open and inclusive. Please read and follow our [Code of Con
18
18
19
19
## <aname="question"></a> Got a Question or Problem?
20
20
21
-
If you have questions about how to *use* Angular CLI, please direct them to [StackOverflow][stackoverflow]. Please note that Angular CLI is still in early developer preview, and the core team's capacity to answer usage questions is limited. We are also available on [Gitter][gitter].
21
+
Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](https://stackoverflow.com/questions/tagged/angular-cli) where the questions should be tagged with tag `angular-cli`.
22
+
23
+
StackOverflow is a much better place to ask questions since:
24
+
25
+
- there are thousands of people willing to help on StackOverflow
26
+
- questions and answers stay available for public viewing so your question / answer might help someone else
27
+
- StackOverflow's voting system assures that the best answers are prominently visible.
28
+
29
+
To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.
30
+
31
+
If you would like to chat about the question in real-time, you can reach out via [our gitter channel][gitter].
22
32
23
33
## <aname="issue"></a> Found an Issue?
24
34
If you find a bug in the source code or a mistake in the documentation, you can help us by
@@ -40,24 +50,23 @@ and help you to craft the change so that it is successfully accepted into the pr
40
50
## <aname="submit"></a> Submission Guidelines
41
51
42
52
### <aname="submit-issue"></a> Submitting an Issue
43
-
Before you submit an issue, search the archive, maybe your question was already answered.
44
53
45
-
If your issue appears to be a bug, and hasn't been reported, open a new issue.
46
-
Help us to maximize the effort we can spend fixing issues and adding new
47
-
features, by not reporting duplicate issues. Providing the following information will increase the
48
-
chances of your issue being dealt with quickly:
54
+
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
55
+
56
+
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario using `ng new repro-app`. Having a reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:
57
+
58
+
- version of Angular CLI used
59
+
-`.angular-cli.json` configuration
60
+
- 3rd-party libraries and their versions
61
+
- and most importantly - a use-case that fails
62
+
63
+
A minimal reproduce scenario using allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem.
64
+
65
+
We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal repository. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.
49
66
50
-
***Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
51
-
***Angular CLI Version** - what version of the CLI is affected (e.g. 0.1.2)
52
-
***Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
53
-
***Browsers and Operating System** - is this a problem with all browsers?
54
-
***Reproduce the Error** - provide a live example (using [Plunker][plunker],
55
-
[JSFiddle][jsfiddle] or [Runnable][runnable]) or a unambiguous set of steps
56
-
***Related Issues** - has a similar issue been reported before?
57
-
***Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
58
-
causing the problem (line of code or commit)
67
+
Unfortunately we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that don't have enough info to be reproduced.
59
68
60
-
You can file new issues by providing the above information [here](https://github.com/angular/angular-cli/issues/new).
69
+
You can file new issues by filling out our [new issue form](https://github.com/angular/angular-cli/issues/new).
61
70
62
71
63
72
### <aname="submit-pr"></a> Submitting a Pull Request (PR)
@@ -95,7 +104,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
95
104
* In GitHub, send a pull request to `angular-cli:master`.
96
105
* If we suggest changes then:
97
106
* Make the required updates.
98
-
* Re-run the Angular CLI test suites for JS and Dart to ensure tests are still passing.
107
+
* Re-run the Angular CLI test suites to ensure tests are still passing.
99
108
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
100
109
101
110
```shell
@@ -137,7 +146,7 @@ from the main (upstream) repository:
137
146
## <a name="rules"></a> Coding Rules
138
147
To ensure consistency throughout the source code, keep these rules in mind as you are working:
139
148
140
-
* All features or bug fixes **must be tested** by one or more specs (unit-tests).
149
+
* All features or bug fixes **must be tested** by one or more specs (unit-tests or e2e-tests).
141
150
* All public API methods **must be documented**. (Details TBC).
142
151
* We follow [Google's JavaScript Style Guide][js-style-guide], but wrap all code at
143
152
**100 characters**.
@@ -230,12 +239,9 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise
With the Angular CLI we can run unit tests as well as create code coverage reports. Code coverage reports allow us to see any parts of our code base that may not be properly tested by our unit tests.
4
+
5
+
To generate a coverage report run the following command in the root of your project
6
+
7
+
```bash
8
+
ng test --watch=false --code-coverage
9
+
```
10
+
11
+
Once the tests complete a new `/coverage` folder will appear in the project. In your Finder or Windows Explorer open the `index.html` file. You should see a report with your source code and code coverage values.
12
+
13
+
Using the code coverage percentages we can estimate how much of our code is tested. It is up to your team to determine how much code should be unit tested.
14
+
15
+
## Code Coverage Enforcement
16
+
17
+
If your team decides on a set minimum amount to be unit tested you can enforce this minimum with the Angular CLI. For example our team would like the code base to have a minimum of 80% code coverage. To enable this open the `karma.conf.js` and add the following in the `coverageIstanbulReporter:` key
18
+
19
+
```javascript
20
+
coverageIstanbulReporter: {
21
+
reports: [ 'html', 'lcovonly' ],
22
+
fixWebpackSourcePaths:true,
23
+
thresholds: {
24
+
statements:80,
25
+
lines:80,
26
+
branches:80,
27
+
functions:80
28
+
}
29
+
}
30
+
```
31
+
32
+
The `thresholds` property will enforce a minimum of 80% code coverage when the unit tests are run in the project.
0 commit comments