Skip to content

Clarify instructions for branch creation in 4th challenge (minor) #246

Description

@DebeeArmstrong

Description

This is a minor concern but could make the challenge easier for a new user of screen readers.

  1. Find the branch dropdown (it shows "main" by default).

the text actually reads "main branch"

  1. Type learn/YOUR-USERNAME (replace YOUR-USERNAME with your actual GitHub username).

You must first tab to the edit field. The only edit field implies it is used to enter a filter. This should be documented as it's confusing.

When you type the learn/userName in the filter field it shows zero branches with that name were found. Though the "create branch" button was read, it was read before you populate the filters edit field.

To get to "create branch" you must tab twice.

  1. Select Create branch: learn/YOUR-USERNAME from main.

This occurs after tabbing first past "tags and then to the "create branch" button. After pressing ENTER or Space on that button the new branch is indeed created and announced and the user is now moved to that branch.

This process is confusing for a screen reader user as one edit field is used to both enter a filter or enter the name for a new branch.

Suggestion: Simply add a few clarifying sentences to either the challenge or a learning card in the documentation, as branch creation is not really covered in either chapter 5 or chapter 6 of the workshop course.

Why Is This Important?

This would be most helpful for those who never created a branch and might be new to using a screen reader. Could also be useful for those with limited vision who, being unable to see the entire screen might not understand why entering a filter is also creating a name for a new branch.

Example or Suggested Change (optional)

Creating a new branch always occurs from the "main branch" drop-down menu. The main branch already exists.

When you drop that menu down, any other branches that exist can be selected. You can also tab to an edit field which asks you to type in a filter string to select branches, but it is also used to enter the name of a new branch you wish to create.

Type in the new branch name then press tab to the tags field. Press tab a second time to arrive at the "create branch" button and press ENTER or space to activate it.

Your new branch will be announced and becomes immediately active.

Category

Select an option...

Effort Level

  • Small (< 30 minutes)
  • Medium (30 minutes - 2 hours)
  • Large (> 2 hours)
  • Unsure

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions