Bhavyai Gupta
Take up one idea. Make that one idea your Life - think of it, dream of it, live on that idea. Let the brain, muscles, nerves, every part of your body, be full of that idea, and just leave every other idea alone. This is the way to success.
- by Swami Vivekananda
The goal of this course is to give you a brief introduction to GitHub. We’ll also provide you with materials for further learning and a few ideas to get you started on our platform.
Git and GitHub
Git is a distributed Version Control System (VCS) that helps track changes as you work on new software development projects. Git tracks the changes you make so you always have a record of what you’ve worked on and you can easily revert back to an older version of your code if need be. It also makes working with others easier—groups of people can work together on the same project and merge their changes into one final source!
GitHub is a collaboration platform. From software to legal documents, you can count on GitHub to help you do your best work with the collaboration and security tools your team needs. With GitHub, you can keep projects completely private, invite the world to collaborate, and streamline every step of your project.
GitHub is also a powerful version control tool. GitHub uses Git, the most popular open source version control software, to track every contribution and contributor to your project—so you know exactly where every line of code came from.
GitHub helps people do much more. GitHub is used to build some of the most advanced technologies in the world. Whether you're visualizing data or building a new game, there's a whole community and set of tools on GitHub that can get you to the next step. This course starts with the basics, but we'll dig into the rest later.
A repository is where your project work happens. It contains all of your project’s files and revision history. You can work within a repository alone or invite others to collaborate with you on those files. As you work more on GitHub you will have many repositories. Use your GitHub dashboard to easily navigate to them. You must be logged in though!
Repositories also contain README’s. You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it. We are using this README to communicate how to learn Git and GitHub with you. 😄
To learn more about repositories read "Creating, Cloning, and Archiving Repositories and "About README's".
Pull requests let you tell others about changes you've pushed to a branch in a repository on GitHub. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add more changes if need be.
Adding someone as a reviewer on your pull request is a signal to them that you want help or would like them to review the content.
To learn more about pull request, read "About Pull Requests".
Use issues to track enhancements, tasks, or bugs for your work on GitHub. Issues are a great way to keep track of all the tasks you want to work on for your project and let others know what you plan to work on. For larger projects, you can keep track of many issues on a project board. GitHub Projects help you organize and prioritize your work and you can read more about them in this "About Project boards document.
Pull requests and issues can also be linked together! You can link a pull request to an issue to show that a fix is in progress and to automatically close the issue when someone merges the pull request.
To learn more about issues and linking them to your pull requests, read "About Issues".
Your profile page tells people the story of your work through the repositories you're interested in, the contributions you've made, and the conversations you've had. You can also give the world a unique view into who you are with your profile README. You can use your profile to let future employers know all about you!
To learn more about your user profile and adding and updating your profile README, read "Managing Your Profile README".
You might have noticed already, but you can minimally style your issues, pull requests, and files (as long as they are .md format!). Using Markdown in your issues, pull requests, and files helps organize your information and make it easier for others to read. You can also drop in gifs and images to convey your point!
To learn more about using GitHub’s flavor of markdown, read "Basic Writing and Formatting Syntax".
The GitHub community is vast. There are many types of people who use GitHub in their day to day—students like you, professional developers, hobbyists working on open source projects, and explorers who are just jumping into the world of software development on their own. There are many ways you can interact with the larger GitHub community, but here are three places where you can start.
If you find a repository interesting or you want to keep track of it, star it! When you star a repository it’s also used as a signal to surface better recommendations on github.com/explore. If you’d like to get back to your starred repositories you can do so via your user profile.
To learn more about starring repositories, read "Saving Repositories with Stars".
You can follow people on GitHub to receive notifications about their activity and discover projects in their communities. When you follow a user, their public GitHub activity will show up on your dashboard so you can see all the cool things they are working on.
To learn more about following users, read "Following People".
GitHub Explore is a great place to do just that … explore 😄 You can find new projects, events, and developers to interact with.
You can check out the GitHub Explore website at github.com/explore. The more you intereact with GitHub the more tailored your Explore view will be.
The GitHub flow is a lightweight workflow that allows you to experiment with new ideas safely, without fear of compromising a project.
You can use branches on GitHub to isolate work that you do not want merged into your final project. Branches allow you to develop features, fix bugs, or safely experiment with new ideas in a contained area of your repository. You always create a branch from an existing branch. Typically, you might create a new branch from the default branch of your repository—main.
Once your new changes have been reviewed by a teammate, or you are satisfied with them, you can merge your changes into the default branch of your repository.
To learn more about branching, read "About Branches".
When you create a repository it exists remotely outside of your local machine. You can clone a repository to create a local copy on your computer and then use Git to sync the two.
You can clone a repository from GitHub to your local computer to make it easier to fix issues, add or remove files, and push larger commits. You can also use an IDE or editing tool of your choice as opposed to the GitHub UI. When you clone a repository, you copy the repository from GitHub to your local machine. Cloning a repository pulls down a full copy of all the repository data that GitHub has at that point in time, including all versions of every file and folder for the project. To learn more about cloning, read "Cloning a Repository".
A fork is another way to copy a repository, but is most commonly used when contributing to someone else’s project. Forking a repository allows you to freely experiment with changes without affecting the original project and is very popular when contributing to open source software projects.
To learn more about forking, read "For a Repo".
- If you weren't able to attend the May 6th lab, be sure to watch the video and follow along.
- Your git settings should already be set from ENSF 593.
- Clone this repository to your local computer.
- Open VSCode and start a new terminal. Make sure that your
ensf592environment is activated. - Edit the top of this
READMEfile to add your first and last name, and your favourite inspirational quote. - Edit the
assignment1code.pyfile by following the instructions in the comments (add your name at the top and change the contents ofstudentNameto be your name. Save. - Run the code by typing the command:
python assignment1code.py(make sure you are in the directory where the file is saved! Use cd to change directories. - Take a screenshot of your successful program run and upload it to your assignment repository.
- Lastly, open the course notes in VSCode or using Anaconda (either Jupyter Lab or Jupyter Notebook is fine).
- Take a screenshot of the welcome chapter and upload it to your assignment repository.
- Commit your edited
READMEand code files, as well as your two new screenshots. - Push your local git history to github:
git push origin master