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: CONTRIBUTING.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
@@ -27,7 +27,7 @@ The sections below outline the steps in each case.
27
27
28
28
## You want to make some kind of change to the code base
29
29
30
-
1. (**important**) this repository implements the best practices we recommend in the Python chapter of the [Guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python). Check that your planned contribution is
30
+
1. (**important**) this repository implements the best practices we recommend in the Python chapter of the [Guide](https://guide.esciencecenter.nl/#/language_guides/python). Check that your planned contribution is
31
31
in line with what is recommended there. If not, please [contribute to the guide](https://github.com/NLeSC/guide/blob/main/CONTRIBUTING.md) instead / as well, or at least create an issue there.
32
32
1. (**important**) announce your plan to the rest of the community _before you start working_. This announcement should be in the form of a (new) issue;
33
33
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
@@ -54,4 +54,4 @@ To create a release you need write permission on the repository.
54
54
1. Fill version, title and description field
55
55
1. Press the Publish Release button
56
56
57
-
Also a Zenodo entry will be made for the release with its own DOI.
57
+
Also a Zenodo entry will be made for the release with its own DOI.
- Runtime dependencies should be added to `pyproject.toml` in the `dependencies` list under `[project]`.
30
30
- Development dependencies, such as for testing or documentation, should be added to `pyproject.toml` in one of the lists under `[project.optional-dependencies]`.
31
31
32
32
## Packaging/One command install
33
33
34
34
You can distribute your code using PyPI.
35
-
[The guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=building-and-packaging-code) can
35
+
[The guide](https://guide.esciencecenter.nl/#/language_guides/python?id=building-and-packaging-code) can
36
36
help you decide which tool to use for packaging.
37
37
38
38
{%ifAddLocalTests -%}
@@ -47,7 +47,7 @@ help you decide which tool to use for packaging.
47
47
- This is configured in `pyproject.toml`
48
48
- The project uses [GitHub action workflows](https://docs.github.com/en/actions) to automatically run tests on GitHub infrastructure against multiple Python versions
49
49
- Workflows can be found in [`.github/workflows`](.github/workflows/)
50
-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=testing)
50
+
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/language_guides/python?id=testing)
51
51
{%- endif%}
52
52
53
53
{%ifAddLocalDocumentation -%}
@@ -61,69 +61,69 @@ help you decide which tool to use for packaging.
61
61
- Check out its [configuration options](https://sphinx-rtd-theme.readthedocs.io/en/latest/).
62
62
- [AutoAPI](https://sphinx-autoapi.readthedocs.io/) is used to generate documentation for the package Python objects.
63
63
{%ifAddOnlineDocumentation%}- `.readthedocs.yaml` is the ReadTheDocs configuration file. When ReadTheDocs is building the documentation this package and its development dependencies are installed so the API reference can be rendered.{%endif -%}
64
-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=writingdocumentation)
64
+
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/language_guides/python?id=documentation)
65
65
{%- endif%}
66
66
67
67
## Coding style conventions and code quality
68
68
69
-
- [Relevant section in the NLeSC guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=coding-style-conventions) and [README.dev.md](README.dev.md).
69
+
- [Relevant section in the NLeSC guide](https://guide.esciencecenter.nl/#/language_guides/python?id=coding-style-conventions) and [README.dev.md](README.dev.md).
70
70
71
71
{%ifAddSonarCloud -%}
72
72
## Continuous code quality
73
73
74
-
[Sonarcloud](https://sonarcloud.io/) is used to perform quality analysis and code coverage report
74
+
[Sonarcloud](https://www.sonarsource.com/products/sonarcloud/) is used to perform quality analysis and code coverage report
75
75
76
-
- `sonar-project.properties` is the SonarCloud [configuration](https://docs.sonarqube.org/latest/analysis/analysis-parameters/) file
76
+
- `sonar-project.properties` is the SonarCloud [configuration](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/analysis-parameters/) file
77
77
- `.github/workflows/sonarcloud.yml` is the GitHub action workflow which performs the SonarCloud analysis
78
78
{%- endif%}
79
79
80
80
## Package version number
81
81
82
-
- We recommend using [semantic versioning](https://guide.esciencecenter.nl/#/best_practices/releases?id=semantic-versioning).
82
+
- We recommend using [semantic versioning](https://packaging.python.org/en/latest/discussions/versioning/).
83
83
- For convenience, the package version is stored in a single place: `pyproject.toml` under the `tool.bumpversion` header.
84
-
- Don't forget to update the version number before [making a release](https://guide.esciencecenter.nl/#/best_practices/releases)!
84
+
- Don't forget to update the version number before [making a release](https://guide.esciencecenter.nl/#/best_practices?id=releases)!
85
85
86
86
## Logging
87
87
88
88
- We recommend using the logging module for getting useful information from your module (instead of using print).
89
89
- The project is set up with a logging example.
90
-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=logging)
90
+
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/language_guides/python?id=logging)
91
91
92
92
{%ifAddChangeLog -%}
93
93
## CHANGELOG.md
94
94
95
95
- Document changes to your software package
96
-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/releases?id=changelogmd)
96
+
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices?id=releases)
97
97
{%- endif%}
98
98
99
99
{%ifAddCitation -%}
100
100
## CITATION.cff
101
101
102
102
- To allow others to cite your software, add a `CITATION.cff` file
103
103
- It only makes sense to do this once there is something to cite (e.g., a software release with a DOI).
104
-
- Follow the [making software citable](https://guide.esciencecenter.nl/#/citable_software/making_software_citable) section in the guide.
104
+
- Follow the [making software citable](https://book.the-turing-way.org/communication/citable/citable-steps) chapter of the Turing Way.
105
105
{%- endif%}
106
106
107
107
{%ifAddCodeConduct -%}
108
108
## CODE_OF_CONDUCT.md
109
109
110
110
- Information about how to behave professionally
111
-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/documentation?id=code-of-conduct)
111
+
- [Relevant section in the Turing Way](https://book.the-turing-way.org/reproducible-research/code-documentation/code-documentation-project#code-of-conduct)
112
112
{%- endif%}
113
113
114
114
{%ifAddContributing -%}
115
115
## CONTRIBUTING.md
116
116
117
117
- Information about how to contribute to this software package
118
-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/documentation?id=contribution-guidelines)
118
+
- [Relevant section in the Turing Way](https://book.the-turing-way.org/reproducible-research/code-documentation/code-documentation-project#contributing-guidelines)
119
119
{%- endif%}
120
120
121
121
## MANIFEST.in
122
122
123
123
- List non-Python files that should be included in a source distribution
124
-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=building-and-packaging-code)
124
+
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/language_guides/python?id=building-and-packaging-code)
125
125
126
126
## NOTICE
127
127
128
128
- List of attributions of this project and Apache-license dependencies
129
-
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/licensing?id=notice)
129
+
- [Relevant section on the Apache License documentation](https://infra.apache.org/licensing-howto.html#mod-notice)
0 commit comments