Skip to content

docs: add initial onboarding guide for new contributors (#49)#50

Draft
josehorta21 wants to merge 5 commits into
mainfrom
feature/issue-49-onboarding-guide
Draft

docs: add initial onboarding guide for new contributors (#49)#50
josehorta21 wants to merge 5 commits into
mainfrom
feature/issue-49-onboarding-guide

Conversation

@josehorta21

Copy link
Copy Markdown

Summary & Changes 📓

  • Resolves: Issue: Weekly Documentation Contributions - josehorta21 #49

  • Summary: This PR adds an initial Onboarding Guide for new practicum contributors to help new students get up to speed quickly with the team's workflow, repository structure, and contribution expectations.

    • 🔨 What does this issue fix? Provides centralized onboarding documentation that didn't previously exist in the Wiki.
    • 👀 What is the expected behavior? New contributors can read a single guide and understand how to pick up issues, name branches, write commits, open PRs, and conduct code reviews.
    • 💭 Any relevant technical details? Pure Markdown documentation — no code changes. New file added at Onboarding/Onboarding-Guide.md.
  • Changes:

    • ✅ Created new directory Onboarding/
    • ✅ Added Onboarding/Onboarding-Guide.md covering repository structure, issue pickup workflow, branch naming, PR workflow, conventional commits, code review etiquette, and where to get help
    • 🛠 Mention breaking changes (if any): None — this is purely additive documentation
    • 🔗 Link relevant discussions/issues: Closes Issue: Weekly Documentation Contributions - josehorta21 #49
    • 📝 Additional info to assist developers & reviewers: Opening this as a draft to get early feedback before marking as ready for review. Happy to iterate on structure or content based on team input.

Added a cheatsheet for common Git commands and outlined expectations for weekly development updates.
@DennizGarza1234

Copy link
Copy Markdown

Reviewed the onboarding guide PR introducing documentation for new contributors. This PR improves the onboarding experience by clearly explaining repository structure, workflow expectations, Git usage, and contribution standards.

@ErmiyasHailemichael

Copy link
Copy Markdown

Good work on this guide! It covers a lot of useful information for new students. Here are a few things I noticed:

  • The branch naming convention uses "docs/" as a prefix, but the Issue Creation wiki page uses "documentation:" — it would be good to make these consistent across the project.
  • The Git Commands Cheatsheet is really helpful and easy to follow.
  • Nice touch, including the Weekly Development Update section — good reminder for new students of what's expected.

Overall, this is a solid guide that will help new contributors get started. The small fixes above would make it even better before merging.

@ching202

Copy link
Copy Markdown

Reviewed the onboarding guide updates and the documentation provides clear explanations for new contributors. The workflow steps and contribution instructions improve the onboarding experience for beginners.

@josehorta21

Copy link
Copy Markdown
Author

Thanks for the thorough feedback, @ErmiyasHailemichael! Really appreciate
you catching the inconsistency.

You're right about the "docs/" vs "documentation:" mismatch. I'll update the
guide in my next commit to align the terminology with what's already used
in the Issue Creation page, so contributors don't get conflicting signals
across the wiki. I'll also keep the Git Commands Cheatsheet section since
you mentioned it landed well.

Will push the consistency fix shortly.

@josehorta21

Copy link
Copy Markdown
Author

Thanks @DennizGarza1234 and @ching202 for taking the time to review! Glad
the workflow steps and Git usage explanations are landing clearly. I'll
keep iterating based on Ermiyas's consistency feedback and add a couple
more sections this week before marking ready for review.

Added a FAQ section covering practicum expectations, Git troubleshooting, and common issues.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

Issue: Weekly Documentation Contributions - josehorta21

4 participants