Skip to content

Latest commit

 

History

History
319 lines (222 loc) · 8 KB

getting-started.md

File metadata and controls

319 lines (222 loc) · 8 KB

Getting Started with Coffee Code Philly

Welcome to the Coffee Code Philly community! This guide will help you get started as a contributor.

Table of Contents

  1. Join the Community
  2. Find a Project
  3. Set Up Your Development Environment
  4. Make Your First Contribution
  5. What's Next

Join the Community

Step 1: Attend an Event

The best way to get started is to attend one of our events:

  1. Visit phillycodes.rsvp
  2. Browse upcoming Coffee & Code sessions
  3. RSVP for an event that works for you
  4. Show up and meet the community!

Step 2: Connect Online

Join our online community channels:

Step 3: Introduce Yourself

Don't be shy! Introduce yourself:

  • Say hi in our community chat
  • Share what you're interested in learning
  • Tell us about your background and skills
  • Ask questions - we're here to help!

Find a Project

Browse Our Repositories

Explore our active projects:

  1. phillycodes.rsvp - Event platform
  2. cafeandcowork - Cafe finder
  3. CCP-Digital-Marketing - Marketing materials
  4. codecoffee-infrastructure - DevOps and infrastructure

Find Your First Issue

Look for beginner-friendly issues:

Good First Issues: Perfect for newcomers

https://github.com/search?q=org%3ACoffee-Code-Philly-Accelerator+label%3Agood-first-issue+state%3Aopen&type=issues

Help Wanted: Issues that need contributors

https://github.com/search?q=org%3ACoffee-Code-Philly-Accelerator+label%3Ahelp-wanted+state%3Aopen&type=issues

Documentation: Always a great place to start

https://github.com/search?q=org%3ACoffee-Code-Philly-Accelerator+label%3Adocumentation+state%3Aopen&type=issues

Express Interest

Once you find an issue:

  1. Read the issue description carefully
  2. Check if anyone else is working on it
  3. Comment: "I'd like to work on this!"
  4. Ask any questions you have
  5. Wait for a maintainer to assign it to you

Set Up Your Development Environment

Prerequisites

Before you start, make sure you have:

  • Git: Version control system
  • GitHub Account: To fork repos and submit PRs
  • Code Editor: VS Code, Sublime, Vim, etc.
  • Programming Language Tools: Depending on the project
    • Python: Python 3.9+, pip, virtual environments
    • Node.js: Node 18+, npm
    • Other: Check repository README

Fork and Clone

  1. Fork the repository on GitHub (click "Fork" button)

  2. Clone your fork locally:

    git clone https://github.com/YOUR-USERNAME/REPO-NAME.git
cd REPO-NAME

  3. Add upstream remote:

    git remote add upstream https://github.com/Coffee-Code-Philly-Accelerator/REPO-NAME.git

  4. Verify remotes:

    git remote -v
# origin    https://github.com/YOUR-USERNAME/REPO-NAME.git (fetch)
# origin    https://github.com/YOUR-USERNAME/REPO-NAME.git (push)
# upstream  https://github.com/Coffee-Code-Philly-Accelerator/REPO-NAME.git (fetch)
# upstream  https://github.com/Coffee-Code-Philly-Accelerator/REPO-NAME.git (push)

Install Dependencies

Follow the project-specific setup instructions in the repository's README.

Python projects:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements-dev.txt

Node.js projects:

npm install

Verify Setup

Run tests to ensure everything works:

# Python
pytest

# Node.js
npm test

See the Development Setup guide for detailed instructions.

Make Your First Contribution

Step 1: Create a Branch

git checkout -b feature/your-feature-name

Branch naming conventions:

  • feature/ - New features
  • fix/ - Bug fixes
  • docs/ - Documentation
  • refactor/ - Code refactoring
  • test/ - Tests

Step 2: Make Changes

  1. Write clean, readable code
  2. Follow the project's style guide
  3. Add tests for new functionality
  4. Update documentation if needed

Step 3: Commit Changes

git add .
git commit -m "Add: brief description of changes"

Good commit messages:

  • Add: user authentication feature
  • Fix: button alignment on mobile
  • Update: installation instructions
  • Refactor: extract utility functions

Step 4: Keep Your Branch Updated

git fetch upstream
git rebase upstream/main

Step 5: Push to Your Fork

git push origin feature/your-feature-name

Step 6: Create a Pull Request

  1. Go to the original repository on GitHub
  2. Click "New Pull Request"
  3. Click "compare across forks"
  4. Select your fork and branch
  5. Fill out the PR template completely
  6. Click "Create Pull Request"

Step 7: Respond to Feedback

  • Address review comments promptly
  • Make requested changes
  • Push updates to your branch
  • Engage in constructive discussion

Step 8: Celebrate! 🎉

Once your PR is merged:

  • You're officially a contributor!
  • Your name will appear in the contributor list
  • You've made Coffee Code Philly better!

What's Next

Continue Contributing

  • Look for more issues to work on
  • Help review other people's PRs
  • Improve documentation
  • Share your knowledge with others

Level Up Your Skills

  • Attend workshops and learning sessions
  • Pair program with other contributors
  • Take on more complex issues
  • Learn new technologies

Get More Involved

  • Participate in hackathons
  • Join project planning discussions
  • Help new contributors get started
  • Consider becoming a maintainer

Share Your Experience

  • Write about what you're building
  • Give talks at community events
  • Create tutorials or blog posts
  • Help spread the word about Coffee Code Philly

Tips for Success

Communication

  • Ask Questions: Don't struggle in silence
  • Be Patient: Maintainers are volunteers
  • Be Respectful: Follow our Code of Conduct
  • Stay Engaged: Respond to comments and feedback

Code Quality

  • Write Tests: Test your changes thoroughly
  • Follow Style Guides: Consistency matters
  • Keep It Simple: Don't over-engineer
  • Document Well: Help others understand your code

Time Management

  • Start Small: Don't bite off more than you can chew
  • Set Realistic Timelines: It's okay to take time
  • Communicate Delays: Let maintainers know if you're stuck
  • It's Okay to Step Away: Life happens!

Common Questions

Q: I'm a beginner. Can I still contribute? A: Absolutely! We welcome contributors of all skill levels. Look for good-first-issue labels.

Q: How long does it take to get a PR reviewed? A: Usually 3-7 days. We're volunteers, so please be patient.

Q: What if I can't finish what I started? A: Just let us know! We can reassign the issue or help you complete it.

Q: Can I work on multiple issues? A: Yes, but please finish one before starting another.

Q: How do I become a maintainer? A: Make consistent, quality contributions and express interest. See GOVERNANCE.md.

For more questions, see our FAQ.

Resources

Welcome to the community! We're excited to build with you. ☕️

Questions? Ask in our Discord/Slack or email [email protected]