-
Notifications
You must be signed in to change notification settings - Fork 13.4k
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
Project: Restaurant Page: Added section on .gitignore templates #27973
Project: Restaurant Page: Added section on .gitignore templates #27973
Conversation
There is a linting issue that needs to be fixed before this can be merged. A heading needs a blank line above and below. Please amend. |
Do you think we need to include this in the project content? Side note, there's a typo |
Yeah I did consider your exact thoughts although thanks for picking up the typo. The reason I felt it was a good addition is I think it's useful for students to know that templates exist when they start their own projects in future. We could maybe add that we don't think students should use one early on but just knowing you can do it seems pretty useful to me. |
That's fair enough @CouchofTomato @Etharialle Also because I just noticed in that previous part, on top of |
I'll make the linting changes and typo correction shortly. I didn't want to go too far down the rabbit hole on gitignore templates, but since it's something students see every time they create a repo I thought it would be worth mentioning (especially since the JavaScript related template is called node instead of JavaScript). That said it's not crucial that it is here and if there is a better place or if it is felt that it is unnecessary this PR can be closed. |
Nah, no need to close the PR. Just offering an opinion above for discussion, but it's not a blocking opinion |
Hey @Etharialle Do you think it is worth making the point that for smaller projects it's unlikely to be useful to use a template vs just adding the directories/files to your own gitignore? We don't want people to go crazy using a template when they'd only gitignore node_modules |
I'm not sure. I typically use a template when creating a project so I don't have to remember to manually create a .gitignore file. I don't think there is much concern about having extra lines in the .gitignore. My main concern would be with projects that include a .env file with secrets in it that are accidentally tracked because a a .gitignore wasn't created or it was manually created, but .env wasn't added. |
Fair enough. Thanks for your contribution. |
Because
The Restuarant Page lesson introduces the
.gitignore
file, but does not mention anything about .gitignore templates which are part of the GitHub web interface when creating a repo. Specifically for JavaScript the common template is actually namednode
which may not be intuitive to students.This PR
.gitignore templates
and brief description.Issue
N/A
Additional Information
Pull Request Requirements
location of change: brief description of change
format, e.g.Intro to HTML and CSS lesson: Fix link text
Because
section summarizes the reason for this PRThis PR
section has a bullet point list describing the changes in this PRIssue
section