A repository for new members to learn git and the GitHub workflow.
- Fork this repository to your own account (creates a copy that you can edit freely)
- Clone your fork to your computer (downloads a copy of your fork to your computer so you can work on it)
- Create a
.md
file in the repository with your name in lowercase (e.g.,leo.md
) using a text editor of your choice (VS Code is a good choice) - In the text file, add your full name and a few sentences about yourself (anything you like, be creative)
- Create a branch for you to work on (
git branch name_of_your_branch
) - Switch to the branch so that changes you make go on that branch (
git switch name_of_your_branch
) - Add the text file to the next commit (
git add name_of_your_file.txt
). In git, this is known as "staging". - Make a new commit (
git commit
) - Push your new branch to GitHub (
git push -u origin name_of_your_branch
). Now the commit and new branch should be in your fork. - Go to the original repository
compgeolab/checkin
(in git, this is known as the "upstream") and create a new pull request. - Make sure the title and description of the pull request are relevant (tells people what you did and why).
- Wait for someone to merge your pull request ("PR")
- In your local clone, go back to the
main
branch (git switch main
) - Pull in the latest changes from the original repository
(
git pull https://github.com/compgeolab/checkin main
) - Your file should now appear in your local clone
- Push the changes to the
main
branch of your fork on GitHub (git push origin main
)