Skip to content

Commit 74ac231

Browse files
committed
Add dev doc question
1 parent ee76bec commit 74ac231

3 files changed

Lines changed: 8 additions & 0 deletions

File tree

copier.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,12 @@ AddSonarCloud:
120120
default: "{{ template_profile != 'minimum' }}"
121121
help: Add SonarCloud (code analysis service) integration?
122122

123+
AddDevDoc:
124+
when: "{{ template_profile == 'ask' }}"
125+
type: bool
126+
default: "{{ template_profile != 'minimum' }}"
127+
help: Add developer documentation?
128+
123129
# internal fields
124130
_subdirectory: template
125131

template/CONTRIBUTING.md.jinja

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ The sections below outline the steps in each case.
3131
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;
3232
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
3333
1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest main commit. While working on your feature branch, make sure to stay up to date with the main branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
34+
{% if AddDevDoc -%}
3435
1. install dependencies (see the [development documentation](README.dev.md#development_install));
36+
{%- endif %}
3537
1. make sure the existing tests still work by running ``pytest``;
3638
1. add your own tests (if necessary);
3739
1. update or expand the documentation;

template/README.dev.md.jinja renamed to template/{% if AddDevDoc %}README.dev.md{% endif %}.jinja

File renamed without changes.

0 commit comments

Comments
 (0)