Skip to content

Hallway Test #554

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

Closed
OleMussmann opened this issue Aug 26, 2024 · 5 comments
Closed

Hallway Test #554

OleMussmann opened this issue Aug 26, 2024 · 5 comments
Assignees

Comments

@OleMussmann
Copy link

A selection of small usability improvements

  • "Select a profile"
    • How to proceed? Press Enter to proceed (probably in copier itself)
  • "Select code quality features"
    • <a> to toggle toggle what? It should probably be <a> to toggle all (probably in copier itself)
    • How to proceed? Press Enter to proceed (probably in copier itself)
  • .gitignore
  • next_steps.md
    • git remote add origin git@github.com:/test_package is missing the org? (validation step needed)
    • Same for "Check automatically generated issues"
    • "Push the initial commit to a new repo on GitHub"
      • Links have double //
  • project_setup.md
    • Lots of unnecessary whitespace/newlines
    • "Package version number"
      • The package version is not in a single place (pyproject.toml), it is also present in src/test_package/__init__.py Is this both bumped? Needs quick testing.
    • MANIFEST.in and NOTICE could use more context, what is it good for?
  • NOTICE has no contributors (validation step needed)
  • README.md
    • Has no title / h1 header
    • Extra empty lines
  • "What is the email address cor code of conduct?" (typo and double-space)
  • Not selecting "docs" or "github actions" still creates all the folders (apparently not implemented yet)
  • Validation step needed for empty "full name"
  • Are more than two keywords allowed? keyword1, keyword2
@NLeSC NLeSC deleted a comment Aug 26, 2024
@PabRod
Copy link
Member

PabRod commented Aug 27, 2024

After trying this for creating a fresh new project with the Let me choose option, these are my user experience comments:

  • +1 to Ole's suggestion a to toggle --> a to toggle all or toggle all
  • i to invert --> i to invert selection or invert selection
  • Delete should remove the default line
  • It asked me to overwrite many files (perhaps the minimal installation is run beforehand?). This may feel scary for some users.

@PabRod
Copy link
Member

PabRod commented Aug 27, 2024

Tried again, now with existing code:

  • My README.md was smashed. Consider appending/prepending the new readme lines to the existing one, without deleting anything.
    • Same with .gitignore
  • It could be good to store the latest email address, name, ..., so the user doesn't have to input it again if unchanged.

@fdiblen
Copy link
Member

fdiblen commented Aug 27, 2024

After trying this for creating a fresh new project with the Let me choose option, these are my user experience comments:

  • +1 to Ole's suggestion a to toggle --> a to toggle all or toggle all
  • i to invert --> i to invert selection or invert selection
  • Delete should remove the default line
  • It asked me to overwrite many files (perhaps the minimal installation is run beforehand?). This may feel scary for some users.

@PabRod: Thanks for these suggestions.
Navigation and shortcuts are handled by copier itself. We have no control of changing it so we cannot implement these suggestings.

Merging and conflict handling are also managed by copier.

@fdiblen
Copy link
Member

fdiblen commented Aug 27, 2024

Tried again, now with existing code:

  • My README.md was smashed. Consider appending/prepending the new readme lines to the existing one, without deleting anything.

    • Same with .gitignore
  • It could be good to store the latest email address, name, ..., so the user doesn't have to input it again if unchanged.

I have created an issue about code of conduct email here: #604

@fdiblen
Copy link
Member

fdiblen commented Aug 27, 2024

A selection of small usability improvements

  • "Select a profile"

    • How to proceed? Press Enter to proceed (probably in copier itself)
  • "Select code quality features"

    • <a> to toggle toggle what? It should probably be <a> to toggle all (probably in copier itself)
    • How to proceed? Press Enter to proceed (probably in copier itself)
  • .gitignore

  • next_steps.md

    • git remote add origin git@github.com:/test_package is missing the org? (validation step needed)

    • Same for "Check automatically generated issues"

    • "Push the initial commit to a new repo on GitHub"

      • Links have double //
  • project_setup.md

    • Lots of unnecessary whitespace/newlines

    • "Package version number"

      • The package version is not in a single place (pyproject.toml), it is also present in src/test_package/__init__.py Is this both bumped? Needs quick testing.
    • MANIFEST.in and NOTICE could use more context, what is it good for?

  • NOTICE has no contributors (validation step needed)

  • README.md

    • Has no title / h1 header
    • Extra empty lines
  • "What is the email address cor code of conduct?" (typo and double-space)

  • Not selecting "docs" or "github actions" still creates all the folders (apparently not implemented yet)

  • Validation step needed for empty "full name"

  • Are more than two keywords allowed? keyword1, keyword2

@OleMussmann: Thank you so much for the feedback! I have created several issues based on your feedback.

@fdiblen fdiblen closed this as completed Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants