git-novice icon indicating copy to clipboard operation
git-novice copied to clipboard

"config --edit" to both check editor config & configure more conveniently

Open katrinleinweber opened this issue 6 years ago • 2 comments

Would it make sense to update the section https://github.com/swcarpentry/git-novice/blame/0f775ae563a09163984e134b068d56928104ee29/_episodes/02-setup.md to something like:

Let's test and review the settings we made just now. Type git config --global --edit to open your git configuration in the text editor that you just configured.

Related to https://github.com/swcarpentry/git-novice/issues/360, because it could prepare learners for switching between CLI & editor during git operations.

katrinleinweber avatar Dec 13 '18 10:12 katrinleinweber

Possibly useful, as it teaches an alternative entry point into the config. In a workshop I taught last week, I did something similar: to teach that the config is just a file, I had students nano ~/.gitconfig to see the options we had just set. This also applies to local .git/config files.

As a test to make sure the config was successful, so helpers can address misconfigurations, this would make sense. On the other hand, committing ourselves and our helpers to resolve configuration difficulties with the myriad possible editors might be a distracting scope creep for this lesson.

tkphd avatar Jun 12 '19 16:06 tkphd

Cool, thanks for sharing your teaching example :-) About "distracting": Would #671 help reduce that risk in your view?

However, since our only config instructions are crucial for the rest of the lessons, helpers will have to debug problems anyway, won't they? IMHO, this is a question of cleverly ordering instructions and checks so that errors do pop-up as quickly as possible.

katrinleinweber avatar Jun 27 '19 05:06 katrinleinweber