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
- New to it? Read Chapters 1 and 2, in that order. They get you signed in and show you round the Workbench. Then go to the chapter for the job in front of you.
- Clearing your inbox? Chapter 3.
- Issues? Chapter 4. Reviewing pull requests? Chapter 5.
- A build failed? Chapter 6, and its section on What Failed.
- Looking after a repository, an organization or who has access? Chapters 7, 8 and 13.
- Looking something up? Chapter 11 has every key, Chapter 12 every place in the Workbench, and Appendix A what GitHub needs for each part.
- Something went wrong? Chapter 10 has the sentences QUILL says when something fails, and what to do about each.
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
- Opening the Workbench. In QUILL, File >
Open from Remote > GitHub Items…. In QUILL Lite,
File > GitHub Workbench…:
Alt+F, thenG. In either, View > GitHub Workbench Mode adds a GitHub menu (Alt+G) with the doors in. F6moves between the tree, the filter, the list, the details and the status bar.- Enter does the obvious thing,
Backspace comes back out, and
Shift+Enteropens the row on GitHub. Ctrl+1toCtrl+0go to a place: Inbox, the current repository, Search, People, Gists, Projects, Watches, Saved Searches, Start Here and Across Repositories.Ctrl+Shift+1toCtrl+Shift+0go to a part of the repository: Issues, Pull Requests, Discussions, Actions and the rest.Alt+1toAlt+9say something without moving you: where you are, what is selected, the item’s state, and more.Alt+Entershows everything about the selected row on one sheet, where you can change it.Shift+F1says everything you can do with the selected row, with each key, and why anything is greyed.F1says what the place and the control are for.Ctrl+Ztakes back your last change on GitHub, where GitHub allows it.Ctrl+Emoves to the filter box.
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.
- What the GitHub Workbench is
- Three promises
- Opening the Workbench
- The first time: permission to connect
- Signing in
- More than one account
- How much the Workbench may change
- The GitHub CLI and your account
- Safe Mode
- A two-minute tour
- Learn it with a guided lesson
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.
- GitHub Workbench Mode and the GitHub menu
- Opening the Workbench
- The panes
- Finding your way round the tree
- Reading a list
- Enter, Shift+Enter and Backspace
- The filter
- Properties
- The context menu and the Item menu
- How QUILL asks before it changes GitHub
- Taking a change back
- The status bar
- What QUILL says, and what it leaves to your screen reader
- Open GitHub Reference: paste any link
- Rate limits and the readout
- F1, and help for every place
- A walk-through: your first five minutes
- Practising on a repository of your own
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.
- Needs My Attention
- Reading your notifications
- Opening a notification
- Invitations
- Inbox rules
- How often QUILL checks
- The Inbox: what needs you to act
- Your open work, split by why it is yours
- Activity
- A walk-through: clearing your inbox in the morning
- Learn it with a guided lesson
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.
- Finding an issue
- Reading an issue
- Commenting
- Reactions
- The timeline
- Writing a new issue
- Labels, milestones and assignees
- Closing and reopening
- Changing many issues at once
- Housekeeping
- Issue fields
- Deleting an issue
- Branches and task lists
- From an issue to a pull request
- Projects
- Starting an issue in its own folder
- A walk-through: one issue, from open to closed
- Learn it with a guided lesson
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.
- Finding the pull requests that need you
- Opening a pull request
- The one-sentence summary
- The review window
- Files you have viewed
- Changed since my last review
- The diff
- Commenting on a line or a range
- Pending comments and sending your review
- Replying and resolving
- Reviews already sent
- Getting a pull request merged
- The whole patch, a revert, and conflicts
- Dependabot’s pull requests
- Drafts, github.dev and Related
- Writing a new pull request
- Learn it with a guided lesson
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.
- Finding a repository’s runs
- What Failed
- Jobs and logs
- Doing something about a run
- Combined check status
- Re-requesting a check
- Starting a workflow
- Looking after workflows
- Deployments and environments
- Artifacts
- Caches
- Self-hosted runners
- Secret and variable names
- A walk-through: reading the practice repository’s failed run
- Learn it with a guided lesson
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.
- Browsing a repository’s files
- Blame and file history
- From the line you are on
- Opening and saving files in QUILL
- Cloning a repository
- Branches
- Setting a commit’s status
- Commit comments
- Tags and releases
- Searching
- Forks, templates and topics
- The community profile
- Dependabot, code owners and configuration
- Insights
- Looking after a repository
- GitHub Pages
- The wiki
- GitHub Models prompt files
- Opening github.dev
- Webhooks, deploy keys and autolinks
- Watching, starring and following
- Packages
- Gists
- Other places under a repository
- A walk-through: from a branch to a tagged release
- Learn it with a guided lesson
Chapter 8: Discussions and security
Discussion threads, answers and polls; then security alerts, dependency review, an organization’s security overview, advisories and secrets.
- Discussions
- Security alerts
- Dependency review on a pull request
- An organization’s security overview
- Security policy and reporting
- Security advisories
- Secrets
- Searching the Advisory Database
- A software bill of materials
- A walk-through: your first discussion
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.
- Your codespaces in the Workbench
- Making a codespace
- The GitHub CLI
- QUILL’s Codespaces commands
- Other things that use Git or the CLI
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.
- Before you start: four quick checks
- How a refusal sounds
- The refusals, one by one
- Held back by the Workbench
- Connecting and signing in
- When GitHub refuses
- Is it GitHub, or is it me?
- When the help itself is wrong
- Advanced: using a token
- Privacy: what goes over the network
- Getting help
Chapter 11: Keyboard reference
Every key the Workbench and its windows answer to.
- The GitHub menu, in workbench mode
- The GitHub Workbench window
- Review pull request
- The diff
- Repository Files
- Actions windows
- Issue windows
- Discussion windows
- Compare branches
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.
- Opening it
- Start Here
- Needs My Attention
- Repositories
- Search
- People, Gists and Projects
- Lists of settings
- Watches
- Why Ctrl+3, Ctrl+4 and Ctrl+8 go places here
- Across Repositories
- Doing things to what is selected
- More commands on rows
- Hearing where you are
- Help and Learning
- Say or Type a Command
- Dry Run
- The GitHub API Console
- Practice on GitHub
- Is it GitHub, or is it me?
- Workbench Options
- A walk-through: finding your way on the practice repository
- Learn it with a guided lesson
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.
- Properties: Alt+Enter on anything
- Many at once
- Undoing a change
- Filtering
- Permissions
- A walk-through: labelling two issues, then taking it back
- Learn it with a guided lesson
Chapter 14: GitHub in QUILL Lite
What is the same in QUILL Lite, and the few things that differ.
- One Workbench, two editors
- Opening it
- The GitHub menu
- Rows that need something only QUILL has
- Files from GitHub
- The guide and the lessons
- A walk-through: the same job in both editors
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.
- How to read it
- Reading
- Issues, pull requests and discussions
- Code, releases and Actions
- Repository settings and security
- Organizations, teams and access
- Enterprise Server
- Outside GitHub