Skip to content

Commit 20a9143

Browse files
authored
Merge pull request #328 from mike-north/master
Chore: Fix issue templates, so the "New Issue" button gives users a choice
2 parents 1e340c2 + 2e663ae commit 20a9143

File tree

8 files changed

+108
-75
lines changed

8 files changed

+108
-75
lines changed

.github/.DS_Store

6 KB
Binary file not shown.
Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,43 @@
1-
<!--
2-
== READ THIS FIRST ==
1+
---
2+
name: 'Other Issues'
3+
about: Other issues relating to ember-cli-typescript
4+
---
5+
6+
<!--
7+
== 🚨🚨🚨 READ THIS FIRST 🚨🚨🚨 ==
38
49
To ensure your issue is given the attention it deserves, we have several templates for specific purposes.
510
Please use the templates below if they apply (via the associated URLs), and post a generalized issue only as a last resort.
611
712
=============[ FOR BUGS ]=============
8-
9-
- Relating to type information:
10-
13+
14+
- Relating to type information:
15+
1116
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-
17+
18+
- Relating to build infrastructure:
19+
1520
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
1621
1722
=============[ LINTING & STATIC ANALYSIS ]=============
1823
1924
- If your issue ONLY has to do with TSLint
20-
25+
2126
https://github.com/typed-ember/ember-cli-tslint/issues/new
22-
27+
2328
- Otherwise
2429
2530
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
2631
2732
=============[ FEATURE REQUESTS ]=============
28-
29-
- Relating to type information:
30-
33+
34+
- Relating to type information:
35+
3136
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-
37+
3338
- Relating to build infrastructure:
34-
39+
3540
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
3641
3742
38-
-->
43+
-->

.github/ISSUE_TEMPLATES/BUILD_BUG.md renamed to .github/ISSUE_TEMPLATE/---build-bug.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "\U0001F41B Build Bug"
3+
about: A problem relating to how TS is built in your ember app
4+
5+
---
6+
17
<!-- This template is for bugs relating to Ember.js typescript support & infrastructure.
28
Please fill out all of the required information below -->
39

@@ -40,11 +46,16 @@ ember install ember-cli-typescript # Set up typescript support
4046
>> Your Instructions Go Here <<
4147

4248
```
43-
<!-- example: "Create a new route, add an action to it as shown in the following code sample" -->
4449

50+
##### Reproduction Case
51+
If you can, please try to fork [this codesandbox](https://codesandbox.io/s/github/mike-north/ember-new-output/tree/ts), and give us an example that demonstrates the problem. Paste the link below so that we can see what's going on
52+
53+
**Link: ** <your link here>
54+
55+
<!-- example: "Create a new route, add an action to it as shown in the following code sample" -->
4556

4657
### Now about that bug. What did you expect to see?
4758
<!-- example: "I expected to be able to invoke my function foo() -->
4859

4960
### What happened instead?
50-
<!-- example: "TypeScript seems to think that there is no function foo()" -->
61+
<!-- example: "TypeScript seems to think that there is no function foo()" -->

.github/ISSUE_TEMPLATES/BUILD_ENHANCEMENT.md renamed to .github/ISSUE_TEMPLATE/---build-enhancement.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "\U0001F381 Build Enhancement"
3+
about: An enhancement relating to Ember.js typescript support & infrastructure
4+
5+
---
6+
17
<!-- This template is for enhancements relating to Ember.js typescript support & infrastructure.
28
Please fill out all of the required information below -->
39

.github/ISSUE_TEMPLATES/TYPES_BUG.md renamed to .github/ISSUE_TEMPLATE/---types-bug.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,29 @@
1+
---
2+
name: "\U0001F41B Types Bug"
3+
about: A problem with the type information for Ember & Ember-Data
4+
5+
---
6+
17
<!-- This template is for bugs relating to Ember.js type information.
28
Please fill out all of the required information below -->
39

410
### Which package(s) does this problem pertain to?
511
- [ ] @types/ember
12+
- [ ] @types/ember__string
13+
- [ ] @types/ember__polyfills
14+
- [ ] @types/ember__object
15+
- [ ] @types/ember__utils
16+
- [ ] @types/ember__array
17+
- [ ] @types/ember__engine
18+
- [ ] @types/ember__debug
19+
- [ ] @types/ember__runloop
20+
- [ ] @types/ember__error
21+
- [ ] @types/ember__controller
22+
- [ ] @types/ember__component
23+
- [ ] @types/ember__routing
24+
- [ ] @types/ember__application
25+
- [ ] @types/ember__test
26+
- [ ] @types/ember__service
627
- [ ] @types/ember-data
728
- [ ] @types/rsvp
829
- [ ] @types/ember-test-helpers
@@ -18,11 +39,17 @@ ember install ember-cli-typescript # Set up typescript support
1839
>> Your Instructions Go Here <<
1940

2041
```
42+
43+
##### Reproduction Case
44+
If you can, please try to fork [this codesandbox](https://codesandbox.io/s/github/mike-north/ember-new-output/tree/ts), and give us an example that demonstrates the problem. Paste the link below so that we can see what's going on
45+
46+
**Link: ** <your link here>
47+
2148
<!-- example: "Create a new route, add an action to it as shown in the following code sample" -->
2249

2350

2451
### Now about that bug. What did you expect to see?
2552
<!-- example: "I expected to be able to invoke my function foo() -->
2653

2754
### What happened instead?
28-
<!-- example: "TypeScript seems to think that there is no function foo()" -->
55+
<!-- example: "TypeScript seems to think that there is no function foo()" -->

.github/ISSUE_TEMPLATES/TYPES_ENHANCEMENT.md renamed to .github/ISSUE_TEMPLATE/---types-enhancement.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,36 @@
1+
---
2+
name: "\U0001F381 Types Enhancement"
3+
about: A feature request for the type information of Ember & Ember-Data
4+
5+
---
6+
17
<!-- This template is for enhancements relating to Ember.js type information.
28
Please fill out all of the required information below -->
39

410
### Which package(s) does this enhancement pertain to?
511
- [ ] @types/ember
12+
- [ ] @types/ember__string
13+
- [ ] @types/ember__polyfills
14+
- [ ] @types/ember__object
15+
- [ ] @types/ember__utils
16+
- [ ] @types/ember__array
17+
- [ ] @types/ember__engine
18+
- [ ] @types/ember__debug
19+
- [ ] @types/ember__runloop
20+
- [ ] @types/ember__error
21+
- [ ] @types/ember__controller
22+
- [ ] @types/ember__component
23+
- [ ] @types/ember__routing
24+
- [ ] @types/ember__application
25+
- [ ] @types/ember__test
26+
- [ ] @types/ember__service
627
- [ ] @types/ember-data
728
- [ ] @types/rsvp
829
- [ ] @types/ember-test-helpers
930
- [ ] @types/ember-testing-helpers
1031
- [ ] Other
1132
- [ ] I don't know
1233

13-
1434
### Please write a user story for this feature
1535

1636
Follow the form

.github/ISSUE_TEMPLATES/CONFIG_ISSUE.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ We have a channel (#e-typescript) on the [Ember Community Discord server](https:
5151

5252
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.
5353

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).
54+
If you don't find an answer, please [open an enhancement request or bug report in this project](https://github.com/typed-ember/ember-cli-typescript/issues/new/choose).
5555

5656
### ⚙️ Issues With Adding TypeScript Support To Apps and Addons
5757

5858
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.
5959

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)
60+
If you don't find an answer, please [open an enhancement request or bug report in this project](https://github.com/typed-ember/ember-cli-typescript/issues/new/choose).
6161

6262
### ✅ Issues With Static Analysis of TypeScript In Ember Apps and Addons
6363

@@ -71,7 +71,7 @@ One sure way to tell which tool is generating an error message is that *Linters
7171
```
7272
`variable-name` is the name of the rule.
7373

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).
74+
For issues relating to typescript compiler analysis, [create an issue in this project](https://github.com/typed-ember/ember-cli-typescript/issues/new/choose). 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).
7575

7676
## Setup and Configuration
7777

@@ -90,7 +90,22 @@ In addition to ember-cli-typescript, we make the following changes to your proje
9090
* We install the following packages—all at their current "latest" value—or generated:
9191

9292
* [`typescript`](https://github.com/Microsoft/TypeScript)
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)
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) which includes
94+
* **@types/ember__string** ([npm](https://www.npmjs.com/package/@types/ember__string) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__string)) - types for the [`@ember/string` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fstring)
95+
* **@types/ember__object** ([npm](https://www.npmjs.com/package/@types/ember__object) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__object)) - types for the [`@ember/object` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fobject)
96+
* **@types/ember__utils** ([npm](https://www.npmjs.com/package/@types/ember__utils) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__utils)) - types for the [`@ember/utils` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Futils)
97+
* **@types/ember__array** ([npm](https://www.npmjs.com/package/@types/ember__array) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__array)) - types for the [`@ember/array` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Farray)
98+
* **@types/ember__component** ([npm](https://www.npmjs.com/package/@types/ember__component) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__component)) - types for the [`@ember/component` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fcomponent)
99+
* **@types/ember__engine** ([npm](https://www.npmjs.com/package/@types/ember__engine) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__engine)) - types for the [`@ember/engine` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fengine)
100+
* **@types/ember__application** ([npm](https://www.npmjs.com/package/@types/ember__application) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__application)) - types for the [`@ember/application` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fapplication)
101+
* **@types/ember__controller** ([npm](https://www.npmjs.com/package/@types/ember__controller) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__controller)) - types for the [`@ember/controller` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fcontroller)
102+
* **@types/ember__service** ([npm](https://www.npmjs.com/package/@types/ember__service) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__service)) - types for the [`@ember/service` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fservice)
103+
* **@types/ember__runloop** ([npm](https://www.npmjs.com/package/@types/ember__runloop) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__runloop)) - types for the [`@ember/runloop` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Frunloop)
104+
* **@types/ember__error** ([npm](https://www.npmjs.com/package/@types/ember__error) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__error)) - types for the [`@ember/error` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Ferror)
105+
* **@types/ember__polyfills** ([npm](https://www.npmjs.com/package/@types/ember__polyfills) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__polyfills)) - types for the [`@ember/polyfills` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fpolyfills)
106+
* **@types/ember__debug** ([npm](https://www.npmjs.com/package/@types/ember__debug) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__debug)) - types for the [`@ember/debug` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fdebug)
107+
* **@types/ember__test** ([npm](https://www.npmjs.com/package/@types/ember__test) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__test)) - types for the [`@ember/test` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Ftest)
108+
* **@types/ember__routing** ([npm](https://www.npmjs.com/package/@types/ember__routing) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__routing)) - types for the [`@ember/routing` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Frouting)
94109
* **@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)
95110
* **@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/)
96111
* **@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)

0 commit comments

Comments
 (0)