Skip to content

Commit f1d3f31

Browse files
committed
Merge branch 'main' into 465-contributing
2 parents d22e516 + e8527f8 commit f1d3f31

5 files changed

Lines changed: 10 additions & 0 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
* Make contributing guidelines optional [#465]()
7+
* Make developer documentation optional [#467](https://github.com/NLeSC/python-template/pull/541)
78
* Make Code of Conduct optional [#464](https://github.com/NLeSC/python-template/pull/530)
89
* New YAML files for copier questions [#529](https://github.com/NLeSC/python-template/pull/529)
910
* Make zenodo next step instructions optional [#520](https://github.com/NLeSC/python-template/pull/520)

copier/questions/features.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,8 @@ AddContributing:
5555
type: bool
5656
default: "{{ template_profile != 'minimum' }}"
5757
help: Add contributing guidelines?
58+
AddDevDoc:
59+
when: "{{ template_profile == 'ask' }}"
60+
type: bool
61+
default: "{{ template_profile != 'minimum' }}"
62+
help: Add developer documentation?

template/next_steps.md.jinja

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,11 @@ A short while after you push your commits to GitHub for the first time, a few is
3838
automatically ([here]({{repository_url}}/issues?q=author%3Aapp%2Fgithub-actions)). Resolve them to complete the
3939
setup of your repository.
4040

41+
{% if AddDevDoc -%}
4142
## Project development documentation
4243

4344
The [README.dev.md](README.dev.md) contains developer documentation.
45+
{%- endif %}
4446

4547
## Project layout explained
4648

template/{% if AddContribution %}CONTRIBUTING.md{% endif %}.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)