diff --git a/CHANGELOG.md b/CHANGELOG.md index 6bd7cda8..ce14ec11 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## [Unreleased] ### Added +* Make contributing guidelines optional [#465]() * Make developer documentation optional [#467](https://github.com/NLeSC/python-template/pull/541) * 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) diff --git a/copier/questions/features.yml b/copier/questions/features.yml index e1ef00f7..c5c6e185 100644 --- a/copier/questions/features.yml +++ b/copier/questions/features.yml @@ -50,6 +50,11 @@ AddCodeConduct: type: bool default: "{{ template_profile != 'minimum' }}" help: Add code of conduct? +AddContributing: + when: "{{ template_profile == 'ask' }}" + type: bool + default: "{{ template_profile != 'minimum' }}" + help: Add contributing guidelines? AddDevDoc: when: "{{ template_profile == 'ask' }}" type: bool diff --git a/template/README.md.jinja b/template/README.md.jinja index 89c9287b..8523375a 100644 --- a/template/README.md.jinja +++ b/template/README.md.jinja @@ -50,10 +50,12 @@ python -m pip install . Include a link to your project's full documentation here. +{% if AddContributing -%} ## Contributing If you want to contribute to the development of {{ package_name }}, have a look at the [contribution guidelines](CONTRIBUTING.md). +{%- endif %} ## Credits diff --git a/template/project_setup.md.jinja b/template/project_setup.md.jinja index f3914fab..3fa94112 100644 --- a/template/project_setup.md.jinja +++ b/template/project_setup.md.jinja @@ -109,10 +109,12 @@ help you decide which tool to use for packaging. - [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/documentation?id=code-of-conduct) {%- endif %} +{% if AddContributing -%} ## CONTRIBUTING.md - Information about how to contribute to this software package - [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/documentation?id=contribution-guidelines) +{%- endif %} ## MANIFEST.in diff --git a/template/CONTRIBUTING.md.jinja b/template/{% if AddContribution %}CONTRIBUTING.md{% endif %}.jinja similarity index 100% rename from template/CONTRIBUTING.md.jinja rename to template/{% if AddContribution %}CONTRIBUTING.md{% endif %}.jinja