Skip to content

Commit 5fb12b5

Browse files
authored
Merge pull request #530 from NLeSC/464-codeconduct
464-Optional code of conduct
2 parents 6663b8c + 68b883d commit 5fb12b5

5 files changed

Lines changed: 11 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
### Added
66

7+
* Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530)
78
* New YAML files for copier questions [#529](https://github.com/NLeSC/python-template/pull/529)
89
* Make zenodo next step instructions optional [#520](https://github.com/NLeSC/python-template/pull/520)
910
* Make SonarCloud optional [#515](https://github.com/NLeSC/python-template/pull/515)

copier/questions/features.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,8 @@ AddSonarCloud:
4545
type: bool
4646
default: "{{ template_profile != 'minimum' }}"
4747
help: Add SonarCloud (code analysis service) integration?
48+
AddCodeConduct:
49+
when: "{{ template_profile == 'ask' }}"
50+
type: bool
51+
default: "{{ template_profile != 'minimum' }}"
52+
help: Add code of conduct?

template/CONTRIBUTING.md.jinja

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing guidelines
22

3-
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).
3+
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 %}
44

55
A contribution can be one of the following cases:
66

template/project_setup.md.jinja

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ help you decide which tool to use for packaging.
7373

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

7878
## Package version number
7979

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

105+
{% if AddCodeConduct -%}
105106
## CODE_OF_CONDUCT.md
106107

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

110112
## CONTRIBUTING.md
111113

template/CODE_OF_CONDUCT.md.jinja renamed to template/{% if AddCodeConduct %}CODE_OF_CONDUCT.md{% endif %}.jinja

File renamed without changes.

0 commit comments

Comments
 (0)