Skip to content

make the questions more coherent and descriptive #654

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

Merged
merged 1 commit into from
Sep 2, 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
9 changes: 5 additions & 4 deletions copier/questions/essential.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# Essential questions
package_name:
type: str
placeholder: my_python_package
help: Enter the name of the Python package.
placeholder: your_python_package
help: Enter the name of the Python package
validator: >-
{% if not (package_name | regex_search('^[a-z][a-z0-9\_]+$')) %}
Package name must start with a letter, followed one or more letters, digits or underscores all lowercase
Expand All @@ -22,10 +22,12 @@ full_name:
help: Enter your full name
validator: >-
{% if not full_name %}
Name cannot be empty
Full name cannot be empty!
{% endif %}
license:
type: str
default: "Apachev2"
help: "Select a license (see: https://choosealicense.com)"
choices:
Apache License, Version 2.0:
value: Apachev2
Expand All @@ -41,4 +43,3 @@ license:
value: GNULesserv3
Other (add your own license):
value: Other
default: "Apachev2"
9 changes: 6 additions & 3 deletions copier/questions/features_code_quality.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ SelectCodeQualityFeatures:
help: Select code quality features
multiselect: true
choices:
Local tests:
Unit tests (using pytest):
value: AddLocalTests_flag
# validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
GitHub Actions (selection on the next menu):
GitHub Actions (select in the next step):
value: SelectGitHubActions_flag
# validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
Linting:
Expand Down Expand Up @@ -58,7 +58,10 @@ SelectGitHubActions:
# computed features
AddLocalTests:
type: bool
default: "{{ 'AddLocalTests_flag' in SelectCodeQualityFeatures or 'AddGitHubActionBuild_flag' in SelectGitHubActions or 'AddSonarCloud_flag' in SelectCodeQualityFeatures }}"
default: "{{
'AddLocalTests_flag' in SelectCodeQualityFeatures
or 'AddGitHubActionBuild_flag' in SelectGitHubActions
or 'AddSonarCloud_flag' in SelectCodeQualityFeatures }}"
when: false
AddGitHubActionBuild:
type: bool
Expand Down
4 changes: 2 additions & 2 deletions copier/questions/features_documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ SelectDocumentationFeatures:
help: Select documentation features
multiselect: true
choices:
Local documentation:
Local documentation (using sphinx):
value: AddLocalDocumentation_flag
# validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
Online documentation (Read the Docs):
Online documentation (using Read the Docs):
value: AddOnlineDocumentation_flag
# validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
Developer documentation:
Expand Down
2 changes: 1 addition & 1 deletion copier/questions/features_publish_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ SelectPublishReleaseFeatures:
help: Select publish and release features
multiselect: true
choices:
Citation (selection on the next menu):
Citation (select in the next step):
value: SelectCitation_flag
# validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
Changelog:
Expand Down
8 changes: 4 additions & 4 deletions copier/questions/package_details.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ package_short_description:
keywords:
type: str
placeholder: keyword1,second keyword,third keyword
help: Add keywords to make your package findable on PyPI
help: Add keywords to make your package findable on PyPI (comma-separated)
github_organization:
type: str
placeholder: "your-github-username or your-github-organization"
placeholder: "your_github_username or your_github_organization"
help: Enter the name of your GitHub username or organization
validator: >-
{% if not (github_organization | regex_search('^\\S*$')) %}
Username or organization cannot include spaces
{% endif %}
email:
type: str
placeholder: yourname@esciencecenter.nl
placeholder: yourname@universe.com
help: What is your email address?
validator: >-
{% if not (email | regex_search('([A-Za-z0-9]+[.-_])*[A-Za-z0-9]+@[A-Za-z0-9-]+(\.[A-Z|a-z]{2,})+')) %}
Expand All @@ -38,7 +38,7 @@ email:
copyright_holder:
type: str
default: "{{ full_name }}"
help: Who is the copyright holder (the default is your full name)?
help: "Who is the copyright holder (default: full name)?"
validator: >-
{% if not copyright_holder %}
This field cannot be empty as it will be used in content of the generated files.
Expand Down