Skip to content

Commit ba6a350

Browse files
1 parent ba9d6e4 commit ba6a350

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Code Quality and Security for Python [![Build Status](https://api.cirrus-ci.com/github/SonarSource/sonar-python.svg?branch=master)](https://cirrus-ci.com/github/SonarSource/sonar-python) [![Quality Gate](https://next.sonarqube.com/sonarqube/api/project_badges/measure?project=org.sonarsource.python%3Apython&metric=alert_status)](https://next.sonarqube.com/sonarqube/dashboard?id=https://next.sonarqube.com/sonarqube/dashboard?id=org.sonarsource.python%3Apython)
2-
#### Python analyzer for SonarQube, SonarCloud and SonarLint
2+
#### Python analyzer for SonarQube, SonarCloud, and SonarLint
3+
4+
Sonar's [Clean Code solutions](https://www.sonarsource.com/solutions/clean-code/?utm_medium=referral&utm_source=github&utm_campaign=clean-code&utm_content=sonar-python) help developers deliver high-quality, efficient code standards that benefit the entire team or organization.
35

46
## Useful links
57

@@ -20,7 +22,7 @@ The easiest way to build the Project is by running:
2022

2123
`mvn clean install -DskipTypeshed`
2224

23-
It builds only Java Maven modules, run tests, and install jar locally.
25+
It builds only Java Maven modules, runs tests, and installs jar locally.
2426
The Python interpreter is not required in that case.
2527

2628
### Full build
@@ -32,16 +34,16 @@ The Python interpreter is not required in that case.
3234
- [tox](https://tox.readthedocs.io/en/latest/) - `pip install tox`
3335
- Run `git submodule update --init` to retrieve [Typeshed](https://github.com/python/typeshed) as a Git submodule
3436

35-
All above should be available in PATH.
37+
All the above should be available in PATH.
3638

37-
To execute full build just run:
39+
To execute the full build just run:
3840

3941
`mvn clean install`
4042

4143
The full build executes [Typeshed](https://github.com/python/typeshed) serializer script.
4244
It generates protobuf messages for Typeshed symbols (for standard Python API) and our customs symbols
4345
(for Python libraries, e.g. [AWS CDK](https://docs.aws.amazon.com/cdk/v2/guide/work-with-cdk-python.html)).
44-
This helps in type inference and providing better rules.
46+
This helps with type inference and providing better rules.
4547

4648
## How to contribute
4749

@@ -59,15 +61,15 @@ and needs to be unique in the whole project.
5961

6062
### Expectations:
6163
- Commit message should be prefixed with the ticket number.
62-
- Working on separate branch and creating PR when it's finished.
63-
- Clean coded, well tested solution, quality gate should pass.
64+
- Working on a separate branch and creating PR when it's finished.
65+
- Clean coded, well-tested solution, quality gate should pass.
6466
- Fix all issues reported by [SonarQube Next](https://next.sonarqube.com/sonarqube/dashboard?id=org.sonarsource.python%3Apython) instance.
65-
- 95% or more code coverage for new changes (if possible). It can be checked on CI build.
67+
- 95% or more code coverage for new changes (if possible). It can be checked on the CI build.
6668

6769
### Before push
6870

6971
Please check if all files have a license header.
70-
If not, the `mvn install` will fail with `Some files do not have the expected license header` message.
72+
If not, the `mvn install` will fail with the `Some files do not have the expected license header` message.
7173
To fix that please execute: `mvn license:format`.
7274

7375
## License

0 commit comments

Comments
 (0)