Skip to content

Commit 8972428

Browse files
chriskrychochriskrycho
authored
Merge pull request #227 from mike-north/master
[docs] Readme: "Getting Help" w/ Issue Templates
2 parents 1dfb156 + 1fdc1fd commit 8972428

File tree

7 files changed

+245
-5
lines changed

7 files changed

+245
-5
lines changed

‎.github/ISSUE_TEMPLATES/BUILD_BUG.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<!-- This template is for bugs relating to Ember.js typescript support & infrastructure.
2+
Please fill out all of the required information below -->
3+
4+
### Please paste the output of `ember -v` here
5+
<!-- example
6+
7+
ember-cli: 3.1.4
8+
node: 10.5.0
9+
os: darwin x64
10+
11+
-->
12+
13+
### Please paste the output of `tsc -v` here
14+
<!-- example
15+
16+
Version 2.9.2
17+
18+
-->
19+
20+
### Please paste your `tconfig.json` and `tslint.json` or `eslint.json` (if applicable) below
21+
22+
23+
<details><summary><b>My tsconfig.json</b></summary><pre>
24+
25+
<!-- Paste your tsconfig.json here -->
26+
27+
</pre></details>
28+
29+
<details><summary><b>My tslint.json or eslint.json</b></summary><pre>
30+
31+
<!-- Paste your tslint.json here -->
32+
33+
</pre></details>
34+
35+
### What are instructions we can follow to reproduce the issue?
36+
```sh
37+
ember new sample; cd ./sample # Create a new ember app
38+
ember install ember-cli-typescript # Set up typescript support
39+
40+
>> Your Instructions Go Here <<
41+
42+
```
43+
<!-- example: "Create a new route, add an action to it as shown in the following code sample" -->
44+
45+
46+
### Now about that bug. What did you expect to see?
47+
<!-- example: "I expected to be able to invoke my function foo() -->
48+
49+
### What happened instead?
50+
<!-- example: "TypeScript seems to think that there is no function foo()" -->

‎.github/ISSUE_TEMPLATES/BUILD_ENHANCEMENT.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- This template is for enhancements relating to Ember.js typescript support & infrastructure.
2+
Please fill out all of the required information below -->
3+
4+
### Please write a user story for this feature
5+
6+
Follow the form
7+
8+
> *As a **role**, I want **feature** so that **reason**.*
9+
10+
> Example:
11+
>
12+
> As an **addon publisher**, I want tobe able to **precompile my addon's typescript into js**, so that **my consumers can use my code, regardless of whether their app is written in typescript**

‎.github/ISSUE_TEMPLATES/CONFIG_ISSUE.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!-- This template is for configuration issues relating to Ember.js typescript support & infrastructure.
2+
Please fill out all of the required information below -->
3+
4+
### Please paste the output of `ember -v` here
5+
<!-- example
6+
7+
ember-cli: 3.1.4
8+
node: 10.5.0
9+
os: darwin x64
10+
11+
-->
12+
13+
### Please paste the output of `tsc -v` here
14+
<!-- example
15+
16+
Version 2.9.2
17+
18+
-->
19+
20+
### Please paste your `tconfig.json` and `tslint.json` or `eslint.json` (if applicable) below
21+
22+
23+
<details><summary><b>My tsconfig.json</b></summary><pre>
24+
25+
<!-- Paste your tsconfig.json here -->
26+
27+
</pre></details>
28+
29+
<details><summary><b>My tslint.json or eslint.json</b></summary><pre>
30+
31+
<!-- Paste your tslint.json here -->
32+
33+
</pre></details>
34+
35+
36+
### What are instructions we can follow to reproduce the issue?
37+
```sh
38+
ember new sample; cd ./sample # Create a new ember app
39+
ember install ember-cli-typescript # Set up typescript support
40+
41+
>> Your Instructions Go Here <<
42+
43+
```
44+
<!-- example: "Create a new route, add an action to it as shown in the following code sample" -->
45+
46+
47+
### Now about that bug. What did you expect to see?
48+
<!-- example: "I expected to be able to invoke my function foo() -->
49+
50+
### What happened instead?
51+
<!-- example: "TypeScript seems to think that there is no function foo()" -->

‎.github/ISSUE_TEMPLATES/TYPES_BUG.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!-- This template is for bugs relating to Ember.js type information.
2+
Please fill out all of the required information below -->
3+
4+
### Which package(s) does this problem pertain to?
5+
- [ ] @types/ember
6+
- [ ] @types/ember-data
7+
- [ ] @types/rsvp
8+
- [ ] @types/ember-test-helpers
9+
- [ ] @types/ember-testing-helpers
10+
- [ ] Other
11+
- [ ] I don't know
12+
13+
### What are instructions we can follow to reproduce the issue?
14+
```sh
15+
ember new sample; cd ./sample # Create a new ember app
16+
ember install ember-cli-typescript # Set up typescript support
17+
18+
>> Your Instructions Go Here <<
19+
20+
```
21+
<!-- example: "Create a new route, add an action to it as shown in the following code sample" -->
22+
23+
24+
### Now about that bug. What did you expect to see?
25+
<!-- example: "I expected to be able to invoke my function foo() -->
26+
27+
### What happened instead?
28+
<!-- example: "TypeScript seems to think that there is no function foo()" -->

‎.github/ISSUE_TEMPLATES/TYPES_ENHANCEMENT.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- This template is for enhancements relating to Ember.js type information.
2+
Please fill out all of the required information below -->
3+
4+
### Which package(s) does this enhancement pertain to?
5+
- [ ] @types/ember
6+
- [ ] @types/ember-data
7+
- [ ] @types/rsvp
8+
- [ ] @types/ember-test-helpers
9+
- [ ] @types/ember-testing-helpers
10+
- [ ] Other
11+
- [ ] I don't know
12+
13+
14+
### Please write a user story for this feature
15+
16+
Follow the form
17+
18+
> *As a **role**, I want **feature** so that **reason**.*
19+
20+
> Example:
21+
>
22+
> As an **addon publisher**, I want tobe able to **precompile my addon's typescript into js**, so that **my consumers can use my code, regardless of whether their app is written in typescript**

‎.github/ISSUE_TEMPLATES/default.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!--
2+
== READ THIS FIRST ==
3+
4+
To ensure your issue is given the attention it deserves, we have several templates for specific purposes.
5+
Please use the templates below if they apply (via the associated URLs), and post a generalized issue only as a last resort.
6+
7+
=============[ FOR BUGS ]=============
8+
9+
- Relating to type information:
10+
11+
https://github.com/typed-ember/ember-cli-typescript/issues/new?template=TYPES_BUG.md&labels=%5Btypes%5D&title=%5B@types/ember%20bug%5D%20-%20%3CYOUR_DESCRIPTION_HERE%3E
12+
13+
- Relating to build infrastructure:
14+
15+
https://github.com/typed-ember/ember-cli-typescript/issues/new?template=BUILD_BUG.md&labels=%5Bbuild%5D&title=%5Bbug%5D%20-%20%3CYOUR_DESCRIPTION_HERE%3E
16+
17+
=============[ LINTING & STATIC ANALYSIS ]=============
18+
19+
- If your issue ONLY has to do with TSLint
20+
21+
https://github.com/typed-ember/ember-cli-tslint/issues/new
22+
23+
- Otherwise
24+
25+
https://github.com/typed-ember/ember-cli-typescript/issues/new?template=CONFIG_ISSUE.md&labels=%5Bconfig%5D&title=%5Bconfig%5D%20-%20-%3CYOUR_DESCRIPTION_HERE%3E
26+
27+
=============[ FEATURE REQUESTS ]=============
28+
29+
- Relating to type information:
30+
31+
https://github.com/typed-ember/ember-cli-typescript/issues/new?template=TYPES_ENHANCEMENT.md&labels=%5Btypes%5D&title=%5B@types/ember%20enhancement%5D%20-%20%3CYOUR_DESCRIPTION_HERE%3E
32+
33+
- Relating to build infrastructure:
34+
35+
https://github.com/typed-ember/ember-cli-typescript/issues/new?template=BUILD_ENHANCEMENT.md&labels=%5Bbuild%5D&title=%5Benhancement%5D%20-%20%3CYOUR_DESCRIPTION_HERE%3E
36+
37+
38+
-->

‎README.md‎

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Use TypeScript in your Ember 2.x and 3.x apps!
44

55
[![*nix build status (master)](https://travis-ci.org/typed-ember/ember-cli-typescript.svg?branch=master)](https://travis-ci.org/typed-ember/ember-cli-typescript) [![Windows build status](https://ci.appveyor.com/api/projects/status/i94uv7jgmrg022ho/branch/master?svg=true)](https://ci.appveyor.com/project/chriskrycho/ember-cli-typescript/branch/master) [![Ember Observer Score](https://emberobserver.com/badges/ember-cli-typescript.svg)](https://emberobserver.com/addons/ember-cli-typescript)
66

7+
* [Getting Help](#getting-help)
78
* [Setup and Configuration](#setup-and-configuration)
89
* [Ember Support](#ember-support)
910
* [`tsconfig.json`](#tsconfigjson)
@@ -38,6 +39,40 @@ Use TypeScript in your Ember 2.x and 3.x apps!
3839
* [Some `import`s don't resolve](#some-imports-dont-resolve)
3940
* [Type safety when invoking actions](#type-safety-when-invoking-actions)
4041

42+
## Getting Help
43+
44+
When seeking help, you should first consider what you need, and which aspect of the Ember+TypeScript ecosystem your issue pertains to.
45+
46+
### 💬 Getting Started
47+
48+
We have an Ember Community Slack channel [#-topic-typescript](https://embercommunity.slack.com/messages/C2F8Q3SK1) where you can ask about getting started, good resources for self-directed learning and more.
49+
50+
### 📚 Issues With Ember Type Definitions
51+
52+
If you've found that some of the Ember type information is missing things, or is incorrect in some way, please first ensure you're using the latest version of the [packages this addon installs](#other-packages-this-addon-installs). Although [StackOverflow](https://stackoverflow.com/questions/tagged/ember.js+typescript) and [Discuss](https://discuss.emberjs.com/search?q=typescript) are not the advised places to report problems, you may find an answer there.
53+
54+
If you still see a problem, please create a bug report [here](https://github.com/typed-ember/ember-cli-typescript/issues/new?template=TYPES_BUG.md&labels=%5Btypes,bug%5D&title=%5B@types/ember%20bug%5D%20-%20%3CYOUR_DESCRIPTION_HERE%3E) or a feature request [here](https://github.com/typed-ember/ember-cli-typescript/issues/new?template=TYPES_ENHANCEMENT.md&labels=%5Btypes,enhancement%5D&title=%5B@types/ember%20enhancement%5D%20-%20%3CYOUR_DESCRIPTION_HERE%3E).
55+
56+
### ⚙️ Issues With Adding TypeScript Support To Apps and Addons
57+
58+
If you run into a problem with the way TypeScript is compiled in Ember apps (i.e., a broccoli error message, incorrect build output, etc...), please first check [StackOverflow](https://stackoverflow.com/questions/tagged/ember.js+typescript) and [Discuss](https://discuss.emberjs.com/search?q=typescript), as you may find an answer.
59+
60+
If you still need help, please open an bug report [here](https://github.com/typed-ember/ember-cli-typescript/issues/new?template=BUILD_BUG.md&labels=%5Bbuild,bug%5D&title=%5Bbug%5D%20-%20%3CYOUR_DESCRIPTION_HERE%3E) or a feature request [here](https://github.com/typed-ember/ember-cli-typescript/issues/new?template=BUILD_ENHANCEMENT.md&labels=%5Bbuild,enhancement%5D&title=%5Benhancement%5D%20-%20%3CYOUR_DESCRIPTION_HERE%3E)
61+
62+
### ✅ Issues With Static Analysis of TypeScript In Ember Apps and Addons
63+
64+
The TypeScript compiler does some very basic static analysis of your code, and most developers use Palantir's TSLint tool for more thorough checking.
65+
66+
One sure way to tell which tool is generating an error message is that *Linters like [TSLint](https://github.com/palantir/tslint/) and [ESLint](https://eslint.org/) will always mention their name, and the name of the pertinent rule, when it alerts you to a violation*.
67+
68+
##### Example:
69+
```
70+
[tslint] variable name must be in lowerCamelCase, PascalCase or UPPER_CASE (variable-name)
71+
```
72+
`variable-name` is the name of the rule.
73+
74+
For issues relating to typescript compiler analysis, create an issue in this repository by clicking [here](https://github.com/typed-ember/ember-cli-typescript/issues/new?template=CONFIG_ISSUE.md&labels=%5Bbuild%5D&title=%5Bconfig%5D%20-%20-%3CYOUR_DESCRIPTION_HERE%3E). For TSLint-related concerns, please create an issue in the [`ember-cli-tslint`](https://github.com/typed-ember/ember-cli-tslint) project by clicking [here](https://github.com/typed-ember/ember-cli-tslint/issues/new). If you run into issues with using ESLint with Ember, create an issue [here](https://github.com/ember-cli/ember-cli-eslint/issues/new).
75+
4176
## Setup and Configuration
4277

4378
To install or upgrade the addon, just run:
@@ -50,14 +85,18 @@ All dependencies will be added to your `package.json`, and you're ready to roll!
5085

5186
In addition to ember-cli-typescript, we make the following changes to your project:
5287

88+
### Other Packages This Addon Installs
89+
5390
* We install the following packages—all at their current "latest" value—or generated:
5491

5592
* [`typescript`](https://github.com/Microsoft/TypeScript)
56-
* [`@types/ember`](https://www.npmjs.com/package/@types/ember)
57-
* [`@types/ember-data`](https://www.npmjs.com/package/@types/ember-data)
58-
* [`@types/rsvp`](https://www.npmjs.com/package/@types/rsvp)
59-
* [`@types/ember-test-helpers`](https://www.npmjs.com/package/@types/ember-test-helpers) – these are the importable test helpers from [RFC #232](https://github.com/emberjs/rfcs/blob/master/text/0232-simplify-qunit-testing-api.md)-style tests
60-
* [`@types/ember-testing-helpers`](https://www.npmjs.com/package/@types/ember-testing-helpers) – these are the globally-available acceptance test helpers
93+
* **@types/ember** ([npm](https://www.npmjs.com/package/@types/ember) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember)) - Types for [Ember.js](https://github.com/emberjs/ember.js)
94+
* **@types/ember-data** - ([npm](https://www.npmjs.com/package/@types/ember-data) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember-data)) - Types for [Ember-Data](https://github.com/emberjs/data)
95+
* **@types/rsvp** - ([npm](https://www.npmjs.com/package/@types/rsvp) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rsvp)) - Types for [RSVP.js](https://github.com/tildeio/rsvp.js/)
96+
* **@types/ember-test-helpers** - ([npm](https://www.npmjs.com/package/@types/ember-test-helpers) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember-test-helpers)) Types for [ember-test-helpers](https://github.com/emberjs/ember-test-helpers), which arose from [RFC #232](https://github.com/emberjs/rfcs/blob/master/text/0232-simplify-qunit-testing-api.md)
97+
* **@types/ember-testing-helpers** - ([npm](https://www.npmjs.com/package/@types/ember-testing-helpers) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember-testing-helpers)) – Types for [Ember's built-in globally-available test helpers](https://github.com/emberjs/ember.js/tree/master/packages/ember-testing/lib/helpers)
98+
99+
### Files this addon Generates
61100

62101
* We add the following files to your project:
63102

0 commit comments

Comments
 (0)