Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

467-Add dev doc question #541

Merged
merged 4 commits into from
Aug 23, 2024
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## [Unreleased]

### Added

* 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)
* Make zenodo next step instructions optional [#520](https://github.com/NLeSC/python-template/pull/520)
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,3 +50,8 @@ AddCodeConduct:
type: bool
default: "{{ template_profile != 'minimum' }}"
help: Add code of conduct?
AddDevDoc:
when: "{{ template_profile == 'ask' }}"
type: bool
default: "{{ template_profile != 'minimum' }}"
help: Add developer documentation?
2 changes: 2 additions & 0 deletions template/CONTRIBUTING.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ The sections below outline the steps in each case.
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;
1. (**important**) wait until some kind of consensus is reached about your idea being a good idea;
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/));
{% if AddDevDoc -%}
1. install dependencies (see the [development documentation](README.dev.md#development_install));
{%- endif %}
1. make sure the existing tests still work by running ``pytest``;
1. add your own tests (if necessary);
1. update or expand the documentation;
Expand Down
2 changes: 2 additions & 0 deletions template/next_steps.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,11 @@ A short while after you push your commits to GitHub for the first time, a few is
automatically ([here]({{repository_url}}/issues?q=author%3Aapp%2Fgithub-actions)). Resolve them to complete the
setup of your repository.

{% if AddDevDoc -%}
## Project development documentation

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

## Project layout explained

Expand Down
Loading