Skip to content
This repository was archived by the owner on Mar 25, 2021. It is now read-only.

Commit d7163e1

Browse files
johnwiseheartJosh Goldberg
authored and
Josh Goldberg
committed
Add tslint-playground to README and bug report template. (#4150)
* Add tslint-playground to docs * Review typos: caps, extra s * Removed release creation section * Comment-ified bug report template * Undid a few more master changes * Just a bit more fixing of the bug report...
1 parent b836f28 commit d7163e1

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+6
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ about: Report a bug in TSLint
1010
- __TypeScript version__:
1111
- __Running TSLint via__: (pick one) CLI / Node.js API / VSCode / grunt-tslint / Atom / Visual Studio / etc
1212

13+
#### Reproduction using [TSLint Playground](https://palantir.github.io/tslint-playground)
14+
15+
<!--
16+
Bug reports for rules should include a reproduction using the tslint-playground website. Click the `Save to URL` button and paste the URL here.
17+
-->
18+
1319
#### TypeScript code being linted
1420

1521
```ts

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,11 @@ Please refer to the full installation & usage documentation on the [TSLint websi
3131
- [customization of TSLint](https://palantir.github.io/tslint/develop/custom-rules/).
3232
- [inline disabling and enabling of rules with comment flags](https://palantir.github.io/tslint/usage/rule-flags/)
3333

34-
## Custom rules & plugins
34+
## TSLint Playground
35+
36+
There is a sandbox environment for TSLint at [palantir.github.io/tslint-playground](https://palantir.github.io/tslint-playground/), which can be used to test rules and see how TSLint works. Issues can be filed against `tslint-playground` [here](https://github.com/palantir/tslint-playground).
37+
38+
## Custom Rules & Plugins
3539

3640
#### Custom rule sets from Palantir
3741

@@ -59,11 +63,10 @@ Prerequisites:
5963
- `node` v7+
6064
- `yarn` v1.0+
6165

62-
#### Quick start
66+
#### Quick Start
6367

6468
```bash
6569
git clone [email protected]:palantir/tslint.git --config core.autocrlf=input --config core.eol=lf
66-
cd tslint
6770
yarn
6871
yarn compile
6972
yarn test

0 commit comments

Comments
 (0)