Skip to content
This repository has been archived by the owner on Apr 27, 2021. It is now read-only.

add github templates and mention twitter in readme #287

Merged
merged 3 commits into from Nov 9, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE.md
@@ -0,0 +1,40 @@
**I want to request a feature.**
<!--
Please describe your request
-->


<!------------------------->
**I want to report a bug.**


**SonarTS version:** <!-- version of SonarJS where you have a bug --><br>
**Node.js version:** <!-- version of Node.js in your environment --><br>
**TypeScript version:** <!-- version of TypeScript in your project --><br>

**SonarQube version:** <!-- version of SonarQube if relevant --><br>
**SonarLint version and used IDE:** <!-- fill if you use SonarTS in your IDE --><br>
**TSLint version:** <!-- version of TSLint if you run SonarTS as a TSLint extension --><br>

**Rule key:** <!-- key of the rule if you are bug reporting on a rule -->

**Reproducer**
```
// minimal reproducer if relevant
console.log("Hello, world"); // False-positive here
```

**Logs**
```
// logs of analysis if relevant
```

**Expected behavior**

<!------------------------->

**I want to provide the following feedback.**

**Rule key:** <!-- key of the rule if you are providing feedback for a rule -->

**Example**
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1 @@
Fixes #<!-- PUT ISSUE NUMBER HERE IF APPLICABLE -->
7 changes: 6 additions & 1 deletion README.md
@@ -1,6 +1,11 @@
# SonarTS [![Build Status](https://travis-ci.org/SonarSource/SonarTS.svg?branch=master)](https://travis-ci.org/SonarSource/SonarTS) [![NPM version](https://badge.fury.io/js/tslint-sonarts.svg)](http://badge.fury.io/js/tslint-sonarts) [![Quality Gate](https://next.sonarqube.com/sonarqube/api/badges/gate?key=sonarts)](https://next.sonarqube.com/sonarqube/dashboard?id=sonarts) [![Coverage](https://next.sonarqube.com/sonarqube/api/badges/measure?key=sonarts&metric=coverage)](https://next.sonarqube.com/sonarqube/component_measures/domain/Coverage?id=sonarts)
Static code analyzer for TypeScript detecting bugs and suspicious patterns in your code.

**Follow us on [twitter](https://twitter.com/sonarjs)** <br>

*[To analyze pure JavaScript code, see SonarJS](https://github.com/SonarSource/sonarjs)*


How does it work?
* The [TypeScript compiler](https://github.com/Microsoft/TypeScript/wiki/Using-the-Compiler-API) provides [**AST**](https://en.wikipedia.org/wiki/Abstract_syntax_tree) and **type** information
* On top of it we build the **symbol model** and the [**control flow**](https://en.wikipedia.org/wiki/Control_flow_graph) model
Expand Down Expand Up @@ -155,7 +160,7 @@ To have this code base locally:

To run the ruling test:
```
cd sonarts-code
cd sonarts-core
yarn ruling
yarn ruling -- --rule <RuleFileName> # to run ruling for a single rule
yarn ruling -- --update # to update the snapshots
Expand Down