Skip to content

Community-Access/learning-room-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Table: Learning Room folder and file purposes Table: Host voice and character mapping for VibeVoice podcast

Welcome to the Learning Room

This repository is your private Learning Room for the Git Going with GitHub workshop. GitHub Classroom created it from the Learning Room template so you can practice the full contribution workflow safely. In this repository you will:

  • File your first issue
  • Leave your first comment
  • Open your first pull request
  • Review a peer's pull request when facilitators pair you for review

Everything in this repository is designed for learning. The files in docs/ have intentional issues that you will find and fix during the workshop contribution sprint.

What Is in This Repository

Folder / File Purpose
docs/welcome.md Introduction to contributing (has some sections to complete)
docs/keyboard-shortcuts.md Keyboard shortcut reference (has some errors to find and fix)
docs/setup-guide.md Setup instructions (has some broken links and gaps)

How to Contribute

  1. Open the canonical challenge list: ../docs/CHALLENGES.md
  2. Find your assigned issue (Issues tab -> filter by "Assignee: me" or search your username in the issue title)
  3. Claim the issue with a comment: I'd like to try this!
  4. Read the issue description - it tells you which file to edit and what to fix
  5. Click the file -> the edit pencil button -> make your change
  6. Commit to a new branch with a descriptive name: fix/[your-name]-[issue-number]
  7. Open a pull request using the PR template and include Closes #XX
  8. Wait for the bot (~30 seconds) - it will check your changes and provide feedback
  9. Read bot feedback carefully - it explains any issues and links to resources
  10. Make changes if needed based on feedback
  11. Request a review from your assigned peer reviewer
  12. Respond to review feedback and make final improvements
  13. Merge when approved (the issue closes automatically)
  14. Add a final issue comment with what you learned and your merged PR link

See the workshop documentation for full step-by-step guidance.

About the Automation Bot

When you open a pull request, an automated bot will:

  • Check your changes against quality standards
  • Validate accessibility (heading hierarchy, link text, alt text, broken links)
  • Provide educational feedback explaining why things matter
  • Link to resources for learning more
  • Apply labels to help facilitators prioritize reviews

The bot is not a substitute for peer review! It provides instant technical feedback so your human reviewers can focus on higher-level improvements, creative suggestions, and encouragement.

How to Interact with the Bot

Reading Bot Comments:

  • Bot posts ONE comment that updates as you make changes
  • Use headings to navigate (Required Checks, Suggestions, Accessibility Analysis, Resources)
  • Each issue includes file/line numbers and how to fix it

Getting Help from the Bot: Comment on your PR with keywords:

  • @bot help - Get help information
  • Mention "merge conflict" - Get conflict resolution guide
  • Mention "request review" - Get instructions for requesting human review

When You Disagree: The bot isn't always right! If you believe feedback is incorrect:

  1. Comment explaining your reasoning
  2. Request human review
  3. Facilitators can override bot checks

Read the Student Guide →

Skills & Progression

As you complete challenges, you'll:

  • Track progress through skill levels (Explorer, Contributor, Collaborator, Operator, Reviewer, Agent Navigator)
  • Unlock new challenges when you reach milestones
  • Earn badges for specific achievements (Branch Builder, PR Pioneer, Conflict Resolver, and more)
  • Celebrate milestones (first challenge, Day 1 complete, all challenges complete)

View Available Challenges → Follow the Full Course Roadmap →

Stuck? Use Guided References

Use these references after you attempt the challenge yourself. They are designed to unblock you, not replace your own practice.

Study Groups

You may be assigned to a study group for collaborative learning. Groups:

  • Work through challenges together
  • Review each other's PRs
  • Share resources and tips
  • Support each other's learning

If assigned to a group, you'll receive an issue thread for communication.

Code of Conduct

All participants and contributors are expected to follow our Code of Conduct. This is a welcoming, accessible space.

Questions?

Open an issue! Use the "Feature or Improvement Request" template if you have a suggestion, or the "Accessibility Bug Report" template if you find an accessibility issue.

About

Pristine sandbox template for Git Going with GitHub cohorts

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors