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 @@ -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)
Expand Down
5 changes: 5 additions & 0 deletions copier/questions/features.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions template/README.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions template/project_setup.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down