Merge pull request #654 from NLeSC/polish-questions

make the questions more coherent and descriptive

copier/questions/essential.yml

@@ -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
@@ -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
@@ -41,4 +43,3 @@ license:
       value: GNULesserv3
     Other (add your own license):
       value: Other
-  default: "Apachev2"

copier/questions/features_code_quality.yml

@@ -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:
@@ -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

copier/questions/features_documentation.yml

@@ -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:

copier/questions/features_publish_release.yml

@@ -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:

copier/questions/package_details.yml

@@ -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,})+')) %}
@@ -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.