Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README with new Clean Code wording and link from Marketing #4177

Merged
merged 1 commit into from Sep 18, 2023
Merged

Update README with new Clean Code wording and link from Marketing #4177

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
@@ -1,6 +1,6 @@
[![Quality Gate](https://next.sonarqube.com/sonarqube/api/project_badges/measure?project=org.sonarsource.javascript%3Ajavascript&metric=alert_status)](https://next.sonarqube.com/sonarqube/dashboard?id=org.sonarsource.javascript%3Ajavascript) [![Coverage](https://next.sonarqube.com/sonarqube/api/project_badges/measure?project=org.sonarsource.javascript%3Ajavascript&metric=coverage)](https://next.sonarqube.com/sonarqube/component_measures/domain/Coverage?id=org.sonarsource.javascript%3Ajavascript)

This SonarSource project is a [static code analyser](https://en.wikipedia.org/wiki/Static_program_analysis) for JavaScript, TypeScript and CSS languages.
This SonarSource project is a [static code analyzer](https://en.wikipedia.org/wiki/Static_program_analysis) for the JavaScript, TypeScript, and CSS languages to produce [Clean code](https://www.sonarsource.com/solutions/clean-code/).

:arrow_right: [Have some feedback?](#support)

Expand All @@ -13,10 +13,10 @@ This SonarSource project is a [static code analyser](https://en.wikipedia.org/wi
- [25 CSS rules](https://rules.sonarsource.com/css)
- Compatible with ECMAScript 2015-2020
- React JSX, Flow, Vue, and AWS lambda functions support for JavaScript and TypeScript
- CSS, SCSS, Less, also 'style' inside PHP, HTML and VueJS files
- Metrics (complexity, number of lines etc.)
- CSS, SCSS, Less, also 'style' inside PHP, HTML, and VueJS files
- Metrics (complexity, number of lines, etc.)
- Import of test coverage reports
- Import of ESLint, TSLint and Stylelint issues
- Import of ESLint, TSLint, and Stylelint issues

# Documentation

Expand All @@ -26,7 +26,7 @@ You can find [documentation here](https://docs.sonarqube.org/latest/analysis/lan

### SonarSource Community Forum

If you want to report a bug, request a feature or provide other kind of feedback, please use [SonarQube Community Forum](https://community.sonarsource.com/). Please do not forget to specify the details of your request, code reproducer, versions of projects you use.
If you want to report a bug, request a feature, or provide other kind of feedback, please use [SonarQube Community Forum](https://community.sonarsource.com/). Please do not forget to specify the details of your request, code reproducer, and versions of projects you use.

# Contributing

Expand All @@ -36,7 +36,7 @@ To request a new feature, create a new thread in [SonarSource Community Forum](h

#### 2. Pull Request

To submit a contribution, create a pull request for this repository. Please make sure that you follow our [code style](https://github.com/SonarSource/sonar-developer-toolset) and all [tests](/docs/DEV.md#testing) are passing.
To submit a contribution, create a pull request for this repository. Please make sure that you follow our [code style](https://github.com/SonarSource/sonar-developer-toolset) and that all [tests](/docs/DEV.md#testing) are passing.

#### Work with us

Expand Down