You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: best_practices/code_quality.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Code Quality
2
2
3
-
Ways to improve code quality are in the [Code quality](https://the-turing-way.netlify.app/code_quality/code_quality.html) chapter on the Turing Way.
3
+
Ways to improve code quality are in the [Code quality](https://the-turing-way.netlify.app/reproducible-research/code-quality.html) chapter on the Turing Way.
4
4
5
-
There are [online software quality improvement tools](https://the-turing-way.netlify.app/code_quality/code_quality.html#Online-services-providing-software-quality-checks) see the [language guides](language_guides/languages_overview.md) for good options per language.
5
+
There are [online software quality improvement tools](https://the-turing-way.netlify.app/reproducible-research/code-quality/code-quality-style.html#online-services-providing-software-quality-checks) see the [language guides](language_guides/languages_overview.md) for good options per language.
Copy file name to clipboardExpand all lines: best_practices/language_guides/python.md
+6-21Lines changed: 6 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,28 +140,13 @@ If this is not possible or does not fit then use one of the generic code coverag
140
140
141
141
## Code quality analysis tools and services
142
142
143
-
Code quality service is explained in the [The Turing Way](https://the-turing-way.netlify.app/code_quality/code_quality.html#Online-services-providing-software-quality-checks).
144
-
There are multiple code quality services available for Python.
145
-
There is not a best one, below is a short list of services with their different strenghts.
143
+
Code quality service is explained in the [The Turing Way](https://the-turing-way.netlify.app/reproducible-research/code-quality/code-quality-style.html#online-services-providing-software-quality-checks).
144
+
There are multiple code quality services available for Python, all of which have their pros and cons.
145
+
See [The Turing Way](https://the-turing-way.netlify.app/reproducible-research/code-quality/code-quality-resources.html) for links to lists of possible services.
146
+
We currently setup [Sonarcloud](https://sonarcloud.io/) by default in our [Python template](https://github.com/NLeSC/python-template).
147
+
To reproduce the Sonarcloud pipeline locally, you can use [SonarLint](https://www.sonarlint.org/) in your IDE.
148
+
If you use another editor, perhaps it is more convenient to pick another service like Codacy or Codecov.
146
149
147
-
### [Codacy](https://www.codacy.com)
148
-
149
-
Code quality and coverage grouped by file.
150
-
Can setup goals to improve quality or coverage by file or category.
151
-
For example project see https://www.codacy.com/app/3D-e-Chem/kripodb/dashboard.
152
-
Note that Codacy does not install your depencencies, which prevents it from correctly identifying import errors.
153
-
154
-
### [Scrutinizer](https://scrutinizer-ci.com/)
155
-
156
-
Code quality and coverage grouped by class and function.
157
-
For example project see https://scrutinizer-ci.com/g/NLeSC/eEcology-Annotation-WS/
158
-
159
-
### [Landscape](https://landscape.io)
160
-
161
-
Dedicated for Python code quality.
162
-
Celery, Django and Flask specific behaviors.
163
-
The Landscape analysis tool called [`prospector`](https://github.com/landscapeio/prospector) can be run locally.
164
-
For example project see https://landscape.io/github/NLeSC/MAGMa
Copy file name to clipboardExpand all lines: best_practices/testing.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ At the Netherlands eScience Center we require minimum of 70% coverage.
57
57
Setting up code coverage for a repository depends on the programming language, see the [language specific guides](language_guides/languages_overview.md) for setup instructions.
58
58
59
59
The code coverage should be performed when a test suite is run as part of Continuous Integration build job.
60
-
The code coverage results can be published on code coverage and/or [code quality services](https://the-turing-way.netlify.app/code_quality/code_quality.html#Online-services-providing-software-quality-checks).
60
+
The code coverage results can be published on code coverage and/or [code quality services](https://the-turing-way.netlify.app/reproducible-research/code-quality/code-quality-style.html#online-services-providing-software-quality-checks).
0 commit comments