feat: Add Git configuration modules for ITP welcome#1885
Conversation
- Configuring Git with VSCode - Creating a Commit - Remote Repositories - Pushing & Pulling Closes CodeYourFuture#1850
✅ Deploy Preview for cyf-curriculum ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
👷 Deploy request for cyf-common pending review.Visit the deploys page to approve it
|
cifarquhar
left a comment
cifarquhar
left a comment
There was a problem hiding this comment.
Hi @Karushna , thanks for this contribution! Apologies for the delay in getting feedback to you - I was away on holiday for a couple of weeks. Overall it looks great, I've added a couple of comments in-line on specific points.
I enabled the deploy preview and it looks like your changes aren't showing up. Did you have any issues testing them locally?
Finally, could you change the branch you're trying to merge into from main to onboarding-updates? These changes are part of a larger project which won't be merged to main until everything is ready.
|
|
||
| ## Step 1: Install Git | ||
|
|
||
| ### On Windows |
There was a problem hiding this comment.
We don't use Windows at CYF, the majority of our trainees will be using Linux unless they have their own Mac. Could you remove the Windows instructions to avoid confusion?
| - `user.email=your.email@example.com` | ||
| - `core.editor=code --wait` | ||
|
|
||
| {{<note type="tip" title="Troubleshooting">}} |
There was a problem hiding this comment.
This would be a great point to remind trainees that they can ask their colleagues for help, or get help in class on a Saturday. Could you add something like: "If the output doesn't make sense you can post a screenshot in Slack, or get help from a volunteer in class".
|
|
||
| You can also stage all files at once: | ||
| ``` | ||
| git add . |
There was a problem hiding this comment.
Can you clarify that this stages all changes in the current directory? At the moment trainees will mainly be working in one directory, but as their projects get more complex this might be a source of confusion.
There was a problem hiding this comment.
This is a great summary of the Git workflow, thanks! It requires some knowledge that our trainees won't have yet, though. So far they have been working exclusively in VSCode and haven't been introduced to the terminal yet (with a couple of exceptions to configure some things). They won't see the terminal for another 2 weeks.
That means we need to either:
- Add a note on how to open/use the terminal in VSCode before using
git init - Reframe this to use VSCode's built-in Git tools
I can see the benefit in both approaches, but I do think it's important for trainees to work with Git at the command line at some point in the course. What do you think? Which approach would you take?
|
|
||
| GitHub will show you a page with instructions. You need to tell your local Git about this remote repository. | ||
|
|
||
| In your terminal, run: |
There was a problem hiding this comment.
It's possible to copy/paste the command from GitHub with the values set correctly - could you add a note to highlight this as an option?
| 6. Choose **"Public"** (so your portfolio is visible) | ||
| 7. **Don't** initialize with README, .gitignore, or license | ||
| 8. Click **"Create repository"** | ||
|
|
There was a problem hiding this comment.
Could you include a screenshot of the new repository page with everything configured for reference?
There was a problem hiding this comment.
I think you've updated the wrong index.md - this one is in the backlog directory, it's the one in the prep directory which needs to be changed.
github-project-automation
Bot
moved this from 📋 Backlog
to 🔖 Ready
in Curriculum Planning
2 participants
Closes #1850