Skip to content

Commit 1fdc1fd

Browse files
committed
Fixes from @chriskrycho review
1 parent e983f97 commit 1fdc1fd

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

.github/ISSUE_TEMPLATES/BUILD_BUG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
1818
-->
1919

20-
### Please paste your `tconfig.json` and `tslint.json` (if applicable) below
20+
### Please paste your `tconfig.json` and `tslint.json` or `eslint.json` (if applicable) below
2121

2222

2323
<details><summary><b>My tsconfig.json</b></summary><pre>
@@ -26,7 +26,7 @@
2626

2727
</pre></details>
2828

29-
<details><summary><b>My tslint.json</b></summary><pre>
29+
<details><summary><b>My tslint.json or eslint.json</b></summary><pre>
3030

3131
<!-- Paste your tslint.json here -->
3232

.github/ISSUE_TEMPLATES/CONFIG_ISSUE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
1818
-->
1919

20-
### Please paste your `tconfig.json` and `tslint.json` (if applicable) below
20+
### Please paste your `tconfig.json` and `tslint.json` or `eslint.json` (if applicable) below
2121

2222

2323
<details><summary><b>My tsconfig.json</b></summary><pre>
@@ -26,7 +26,7 @@
2626

2727
</pre></details>
2828

29-
<details><summary><b>My tslint.json</b></summary><pre>
29+
<details><summary><b>My tslint.json or eslint.json</b></summary><pre>
3030

3131
<!-- Paste your tslint.json here -->
3232

.github/ISSUE_TEMPLATES/TYPES_ENHANCEMENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- This template is for enhancements relating to Ember.js type information.
22
Please fill out all of the required information below -->
33

4-
### Which package(s) does this problem pertain to?
4+
### Which package(s) does this enhancement pertain to?
55
- [ ] @types/ember
66
- [ ] @types/ember-data
77
- [ ] @types/rsvp

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,33 +45,33 @@ When seeking help, you should first consider what you need, and which aspect of
4545

4646
### 💬 Getting Started
4747

48-
We have an [Ember Community Slack channel](https://embercommunity.slack.com/messages/C2F8Q3SK1) where you can ask about getting started, good resources for self-directed learning and more.
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.
4949

5050
### 📚 Issues With Ember Type Definitions
5151

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

5454
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).
5555

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

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

6060
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)
6161

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

6464
The TypeScript compiler does some very basic static analysis of your code, and most developers use Palantir's TSLint tool for more thorough checking.
6565

66-
One sure way to tell which tool is generating an error message is that *TSLint will always mention the name of the pertinent rule, when it alerts you to a violation*.
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*.
6767

6868
##### Example:
6969
```
7070
[tslint] variable name must be in lowerCamelCase, PascalCase or UPPER_CASE (variable-name)
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).
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).
7575

7676
## Setup and Configuration
7777

0 commit comments

Comments
 (0)