[HERMES Init]: User Experience Feedback

[poikilotherm]

After testing following our tutorial, I found the following issues:

🚨 CRITICAL

• Using the latest release on PyPI via pip install hermes and applying it to github.com/gdcc/xoai, I was not able to execute the init command at all. It stumbled over some falsly detected Gitlab URL...? Using the current state on develop gave me a working command. We should release a newer version very soon!
• Github Templates are outdated ci-templates#15
• The tutorial should explicitely mention to make sure to have the latest hermes release installed. Some folks were struggeling with broken commands.

🐛 MAJOR

• When selecting files to include in the artifact:
  • An option to choose "Nothing" to be included in the artifact is missing.
  • When choosing "custom path", giving no input (just hitting enter), it equals "everything" (unexpected, no warning).
  • There is no confirmation whether the selected files are what the user want to be included or not.
  • There is no way to edit the list. At least give a hint how to change this later, maybe add an option to clear the selection.
• After the setup is done, the configuration and github bits are not added to the git index (the tutorial mentions that). The CLI output suggests otherwise! ("HERMES ready to use")
• When something goes wrong and the setup is cancelled, give a hint that the user will need to start over
• On Github: when the error is 403, ask the user if they did actually grant permission to the application (easy to miss/forget/misclick)

🍒 MINOR

• When selecting files to include in the artifact:
  • Maybe support tab completion?
  • Maybe provide file tree with selection options?
  • Have an editor for the selection list
• When something goes wrong, the user needs to start over completely. There is no hint that this will be the case. It would be much nicer to have an option to reuse some of the previous answers, giving a choice to start over or continue.
• Should we ask the user if they want to create the changes on a new branch? And also: maybe stash away any changes including untracked files?
• It would be great to have a selection of branch names. The current branch, the default branch or provide a custom name as choosable options would be great. Maybe even have an autocomplete option?
• I immediately felt the urge to use arrow keys to navigate to options, but that is not implemented

[poikilotherm]

This was mostly addressed by #463