Skip to content
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

Recommended comments to clarify sections #891

Open
SARAHHETTEMA opened this issue Sep 1, 2022 · 1 comment
Open

Recommended comments to clarify sections #891

SARAHHETTEMA opened this issue Sep 1, 2022 · 1 comment

Comments

@SARAHHETTEMA
Copy link

I noticed a few areas where comments in the code could help clarify next steps and avoid running into error messages:

In the directories section (https://swcarpentry.github.io/git-novice/04-changes/index.html#directories): there is a code block "git add ". I think it would be helpful to add a comment such as "#use this general form to add all files in the directory at once" or remove the code formatting. I find it can be confusing to have a code chunk that is not supposed to be executed in the lesson without some additional commentary that the line of code is just example formatting.

In the Ignoring things episode (https://swcarpentry.github.io/git-novice/06-ignore/index.html#overview): for the "nano .gitignore" line. I would add a comment to the output section that you need to edit the nano file with the "*.dat results/" text then run git status. I think either a comment next to the nano line or a line before the code chunk would clarify and prevent folks from getting stuck on that section.

@emcaulay
Copy link

HI @SARAHHETTEMA,

These are really helpful suggestions! Thank you for making them. I think both suggestions are worth incorporating into the lesson. I might work with the lesson maintainers to see if I can draft some revisions.

SvenMarcus added a commit to SvenMarcus/git-novice that referenced this issue Feb 8, 2023
In issue swcarpentry#891 proposed to add some additional comments on the creation of the `.gitignore` file in order to clarify that learners need to add the ignore patterns to the files themselves.
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

2 participants