The GitHub Guide for QUILL and QUILL Lite

This is the book on doing GitHub work with a screen reader in QUILL and QUILL Lite: answering what needs you, reading and triaging issues, reviewing pull requests line by line, finding out why a build failed, browsing code, and looking after repositories, teams and access. It is a book of its own, beside each editor’s user guide, because there is a lot to say and you may only need part of it.

You write in the editor, and you do GitHub work in the GitHub Workbench, one window for everything GitHub. The same Workbench ships in both editors, and so does this book. Where the two differ, a short paragraph starting In QUILL Lite says how, and Chapter 14 lists every difference.

How to read this book

Every chapter starts with why you are there, what you will do and what you will have at the end, and most end with a walk-through on a practice repository of your own and the guided lesson that goes with it. Headings are real headings: each chapter is a level 3 heading on this page, so pressing 3 in JAWS or NVDA moves from chapter to chapter, and inside a chapter its topics are level 2 headings. At the bottom of every chapter are links to the chapters either side and back to these contents.

Keys at a glance

Chapter 11 has every key.

The chapters

Chapter 1: Getting started

What the Workbench is, opening it in each editor, the one question QUILL asks before it connects, signing in with GitHub, keeping more than one account, an Enterprise Server, how much the Workbench may change, and Safe Mode. It ends with a two-minute tour.

Chapter 2: A tour of the GitHub Workbench

The GitHub menu, then the Workbench window: its tree and Go keys, lists, the filter, Properties, the context menu, how QUILL asks before it changes anything, Ctrl+Z and Change History, the status bar, pasting a link, GitHub’s hourly allowance, and the help keys.

Chapter 3: Your inbox and your work

Needs My Attention: reading and clearing your notifications from the keyboard, invitations, inbox rules, the Inbox that gathers everything waiting on you, and your own open work.

Chapter 4: Issues

Finding, reading and commenting on issues, writing one from a template or an issue form, labels, milestones, types and fields, closing, many at once, relationships, Projects, and starting work in a folder of its own.

Chapter 5: Pull requests and review

The pull requests that need you, the review outline and its one-sentence summary, the diff, comments on a line or a range, sending a review, and everything that gets a pull request merged.

Chapter 6: Actions and checks

Workflow runs, What Failed, jobs and logs, re-running and cancelling, checks, starting and editing workflows, deployments and environments, artifacts, caches and runners.

Chapter 7: Code and repositories

Files at any branch, tag or commit, blame and history, GitHub from the line you are on, branches, tags and releases, search, configuration, insights, looking after a repository, the wiki, webhooks, packages and gists.

Chapter 8: Discussions and security

Discussion threads, answers and polls; then security alerts, dependency review, an organization’s security overview, advisories and secrets.

Chapter 9: Codespaces and the GitHub CLI

Your codespaces in the Workbench, making one, and the GitHub CLI, including how QUILL keeps the two sign-ins on the same account.

Chapter 10: Troubleshooting, privacy and help

The sentences QUILL says when something fails, what each means and what to do about it, using a token instead of signing in, exactly what goes over the network, and how to reach a person.

Chapter 11: Keyboard reference

Every key the Workbench and its windows answer to.

Chapter 12: The GitHub Workbench, place by place

The Workbench a place at a time: Start Here, Needs My Attention, each repository’s parts, Search, People, Watches, Across Repositories, the help places, Dry Run, the API Console, the practice repository and Workbench Options.

Chapter 13: Properties, filters and permissions

Alt+Enter on anything: the Properties sheet, changing many things at once, undoing a change, filtering a list on anything, and permissions: yours, the Workbench levels, and who else has access.

Chapter 14: GitHub in QUILL Lite

What is the same in QUILL Lite, and the few things that differ.

Appendix A: What GitHub needs for each part of the Workbench

What GitHub needs for each part of the Workbench: your role, your sign-in’s permissions, and the features a repository or organization must have.