Three tools
Issues track work, discussions talk, pull requests change code
An issue is work to do. A discussion is a conversation. A pull request is a proposed change.
Collaboration on GitHub happens in three places, and the exam asks which one fits. An issue is a piece of work: a bug, a task, a feature. It is open until it is done, then closed. It can be assigned and labelled. A discussion is a conversation with nothing to close: a question, an idea, a poll. An answer can be marked. A pull request is a proposed change to the code. It carries commits, gets a review, and ends in a merge.
Three tools · Going deeper
The parts of an issue
Assignees, labels, milestones and sub-issues.
Linking
A closing keyword ties a pull request to its issue
Closes #42 in a pull request closes issue 42 when it merges.
Issues and pull requests work as a pair. Here is issue forty two. A bug, still open. Someone opens a pull request to fix it, and writes closes number forty two in the description. That keyword links the two, and each now shows the other. When the pull request is merged into the default branch, GitHub closes the issue automatically. Nobody has to remember to do it.
Linking · Going deeper
Pull request states and review verdicts
Draft, open, merged, closed; approve or request changes.
Check yourself
The pull request is merged into main. What happens to issue 12?
Pull requests
One page for the change, the talk, the checks and the review
Four tabs, and a review that ends in comment, approve or request changes.
Look inside a pull request. It has four tabs. Conversation holds the discussion. Commits lists what was added. Checks shows the automated tests. Files changed shows the difference, line by line. A reviewer reads the changes and finishes with one of three verdicts. Comment gives feedback without deciding. Approve says it is ready. Request changes says it must be fixed first. Once it is approved and the checks pass, it can be merged.
Pull requests · Going deeper
Templates, assignments and filters
Templates pre-fill, assignees own, filters find.
Notifications
Subscribed, involved or named: that is why you are told
Watching, participating, @mentions and assignments all feed one inbox.
GitHub can send a great many notifications, so know where they come from. There are four reasons. You are watching the repository. You took part in the thread. Someone mentioned you by name. Or you were assigned, or asked for a review. All of these feed one stream. And you choose where it arrives: the inbox on GitHub, email, or the mobile app. To hear less, change what you watch, or unsubscribe from a thread.
Notifications · Going deeper
Watch settings and the inbox
Participating, All Activity, Ignore or Custom.
Check yourself
Which watch setting gives this person what they want?
Gists, wikis and Pages
A snippet, a manual, a website
A gist shares a snippet, a wiki holds documentation, GitHub Pages hosts a website.
Three more features share written content, and the exam offers them against each other. A gist is for a snippet: one file or a few, shared by a link. It can be public, or secret. A wiki is for documentation. It is a tab on the repository, with pages written in Markdown. GitHub Pages is for a website. It publishes files from a repository at a GitHub dot I O address, or at your own domain.
Gists, wikis and Pages · Going deeper · 1 of 2
Gists, wikis and Pages compared
A secret gist is not private. Pages serves static files.
Gists, wikis and Pages · Going deeper · 2 of 2
Clue words for collaboration
Issue, discussion, pull request, gist, wiki and Pages.
Check yourself
What is the best way to share this?
Lesson complete
You finished “Issues, pull requests and discussions”
Answer the questions along the way to see your score here.