Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

### Added

* Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530)
* New YAML files for copier questions [#529](https://github.com/NLeSC/python-template/pull/529)
* Make zenodo next step instructions optional [#520](https://github.com/NLeSC/python-template/pull/520)
* Make SonarCloud optional [#515](https://github.com/NLeSC/python-template/pull/515)
Expand Down
5 changes: 5 additions & 0 deletions copier/questions/features.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,8 @@ AddSonarCloud:
type: bool
default: "{{ template_profile != 'minimum' }}"
help: Add SonarCloud (code analysis service) integration?
AddCodeConduct:
when: "{{ template_profile == 'ask' }}"
type: bool
default: "{{ template_profile != 'minimum' }}"
help: Add code of conduct?
2 changes: 1 addition & 1 deletion template/CONTRIBUTING.md.jinja
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing guidelines

We welcome any kind of contribution to our software, from simple comment or question to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/). Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
We welcome any kind of contribution to our software, from simple comment or question to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/). {% if AddCodeConduct -%}Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).{%- endif %}

A contribution can be one of the following cases:

Expand Down
6 changes: 4 additions & 2 deletions template/project_setup.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ help you decide which tool to use for packaging.

- `sonar-project.properties` is the SonarCloud [configuration](https://docs.sonarqube.org/latest/analysis/analysis-parameters/) file
- `.github/workflows/sonarcloud.yml` is the GitHub action workflow which performs the SonarCloud analysis
{%- endif -%}
{%- endif %}

## Package version number

Expand All @@ -100,12 +100,14 @@ help you decide which tool to use for packaging.
- To allow others to cite your software, add a `CITATION.cff` file
- It only makes sense to do this once there is something to cite (e.g., a software release with a DOI).
- Follow the [making software citable](https://guide.esciencecenter.nl/#/citable_software/making_software_citable) section in the guide.
{%- endif -%}
{%- endif %}

{% if AddCodeConduct -%}
## CODE_OF_CONDUCT.md

- Information about how to behave professionally
- [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/documentation?id=code-of-conduct)
{%- endif %}

## CONTRIBUTING.md

Expand Down