This is an overview of the parts of GitHubt from the view on a repository page. It has links to the relevant GitHub documentation for more detail.
Top of page¶
The very top menu with the github logo in it has GitHub level menus that are not related to the current repository.
Repository specific page¶
This is the main view of the project
Branch menu & info, file action buttons, download options (green code button)
About has basic facts about the repo, often including a link to a documentation page
File panel
the header in this area lists who made the last commit, the message of that commit, the short hash, date of that commit and the total number of commits to the project.
If there are actions on the repo, there will be a red x or a green check to indicate that if it failed or succeeded on that commit.
file list: a table where the first column is the name, the second column is the message of the last commit to change that file (or folder) and the third column is when is how long ago/when that commit was made
Releases, Packages, and Environments are optional sections that the repo owner can toggle on and off.
Releases mark certain commits as important and give easy access to that version. They are related to git tags
Packages are out of scope for this course. GitHub helps you manage distributing your code to make it easier for users.
Environments are a tool for dependency management. We will cover thigns that help you know how to use this feature indirectly, but probably will not use it directly in class. This would be eligible for a build badge.
README file
The bottom of the right panel has information about the languages in the project
a filterable list of issues. the controls here hep you sort and find specific issues. the green button on the right helps you make a new issue.
By default it only shows open issues. to see closed ones, edit the text in the search box.
A filter-able list of all the pull requests in the repo.
By default it only shows the open pull requests, to see merged and closed ones, edit the text in the search box.
This page allows you to run and view output from automatically run GitHub Actions.
A list of all of the projects linked to this repository and a button to add more.
This tab tells you if code dependencies have had security issues reported. This is out of scope for this course. GitHub’s code security features are important when you are distributing code, but the particulars are language specific, so we will not discuss this much here.
This could be a topic for an explore or build badge.
GitHub provides analysis of the activity in the repository.
You will only see this tab if you have admin rights on the repository. This is where you can control high level things including:
add collaborators
deploy a website with GitHub Pages