Assignment 1 - Part B: Markdown Resume
Objectives
- Git: Collaborate as a team in a single repository using Git.
- Markdown: Use Markdown as a markup language to write simple resume.
Prerequisites
- Read the notes of the first week Part 2: Basics of Git and Github.
- Familiarity with Git basic line commands. Refer to the preprinted git cheat sheet that we have received previously (PDF version).
- Familiarity with Markdown formatting. Refer to the preprinted Markdown fold that we have received previously (PDF version).
- Install an editor for Markdown files like VSCode.
Deadline
Saturday, 1st March 2020, 11:59 PM.
Assignment Registration
- Know your team id from the sheet SBE201-2020-Teams.
- Go to the assignment page [SBE201-2020] Week1b Markdown Resume.
If you are the team leader, create a new team using the pattern SBE201-2022-TeamXX, where XX is the team number in two digits. For example, if your team number is 9, you will use SBE201-2022-Team09 |
---|
Otherwise, if you are not the team leader, find your team label as SBE201-2022-TeamXX, where XX is the group number in two digits, then join it. If you don’t find it then your team leader hasn’t yet registered your team. |
- After that, team members can clone the remote repository to their local machines.
Start working in your resume
- After cloning your repository of your team, open the folder using Visual Studio Code, and work in your Markdown file.
- The team should write their plain resumes in separate files. You should find 6 files, choose the one associated with order your name appeared SBE201-2020-Teams.
- Start drafting a basic resume of yours, you may use
asem.md
as a template. - You can find extra guidelines in the
README.md
file of your repository. - After finishing, add your name in the table in the
README.md
file. - A reference for GitHub emojis
Submission
After finishing your changes, commit:
git commit -a -m "added my resume..."
Make sure you are updated with the remote repository before pushing:
git pull origin master
Push:
git push origin master
Notes: Public Key Authentication
You are expected to execute the following git commands too often:
-
git clone url
: which clones the remote repository for the first time. -
git pull origin master
: which merges the updates on the remote repository (almost made by your teammates) into your local repository. -
git push origin master
: that publishes your local updates to the remote repository.
Each of these commands requires you to provide your username and password . It becomes boring when you frequently make changes and updates. Follow Steps for using Public Key Authentication for accessing your GitHub repositories that guides you towards using public key authentication instead of using the username and password.
Warning: Bad practices that risks your repository and team work
- Never use the GitHub website interface to upload your work manually. This will almost ruin the work of your teammates. You should only rely on the git commands.
- When you publish your changes, it may happen that one of your teammates has published some updates before you do, so you need to
git pull origin master
first. So never use as a solution:git push -f origin master
(by adding-f
) orgit push --force origin master
(by adding--force
flag). This is guaranteed to ruin and overwrite your teammates work.