Welcome to the HacktobHERfest Broken Repo - a fun, beginner-friendly React project where you can practice contributing to open source by fixing small "broken" issues! This is the perfect place to learn GitHub workflows, pull requests, and collaborative coding in a supportive environment.
This is a themed React landing page for SheCodesOKC's HacktobHERfest event. The codebase has some intentional "bugs" (like typos and missing letters) that are perfect for first-time contributors to find and fix. It's designed to be educational, fun, and welcoming to everyone!
- A GitHub account
- Git installed on your computer
- Node.js and npm installed
-
Fork the repository ๐ด
- Click the "Fork" button in the top-right corner of this page
- This creates your own copy of the project
-
Clone your fork locally ๐ฅ
git clone https://github.com/YOUR_USERNAME/hacktober-broken-repo.git cd hacktober-broken-repo
-
Install dependencies ๐ฆ
npm install
-
Start the development server ๐โโ๏ธ
npm run dev
-
Open in your browser ๐
- Visit
http://localhost:5173
- You should see the HacktobHERfest landing page!
- Visit
Check out the Issues tab on GitHub to find fun broken things to fix! Each issue will have:
- A description of what's broken
- Which file to look in
- What the fix should be
- Difficulty level (beginner-friendly!)
-
Pick an issue ๐
- Go to the Issues tab and find something that looks fun to fix
- Comment on the issue to let others know you're working on it
-
Create a new branch ๐ฟ
git checkout -b fix/your-issue-description
Example:
git checkout -b fix/header-typo
-
Make your changes โ๏ธ
- Open the file mentioned in the issue
- Fix the broken code (typos, missing letters, etc.)
- Test your changes by refreshing the browser
-
Add yourself to the Contributors Wall ๐
- Open
src/components/Contributors.jsx
- Add your GitHub handle to the contributors array
const contributors = [ { name: "UserName", github: "https://github.com/USERNAME" }, ]
- Open
-
Commit your changes ๐พ
git add . git commit -m "Fix: [describe what you fixed]"
-
Push your branch โฌ๏ธ
git push origin fix/your-issue-description
-
Open a Pull Request ๐
- Go to your fork on GitHub
- Click "Compare & pull request"
- Fill out the PR description
- Submit your PR!
-
Celebrate! ๐
- Once your PR is merged, your name will appear on the Contributors Wall
- You've just made your first open source contribution!
This project includes several festive elements:
- ๐จ Contributors Wall: See all the amazing people who've contributed!
- ๐ Festive Hover Effects: Rainbow gradients and fun animations
- ๐ป Playful "Ghost" Bugs: Intentional typos and missing letters (with fun comments!)
- ๐ Halloween Theme: Perfect for HacktobHERfest season
- GitHub Issues - Find bugs to fix
- GitHub Docs for Beginners - Learn GitHub basics
- How to Contribute to Open Source - General contribution guide
- SheCodesOKC - Learn more about our community
- Check the Issues tab for guidance
- Ask questions in the issue comments
- Join the SheCodesOKC community for support
- Remember: Everyone was a beginner once! ๐
src/
โโโ components/
โ โโโ Header.jsx # Main header with logo and title
โ โโโ Hero.jsx # Welcome section with CTA button
โ โโโ Contributors.jsx # Contributors wall
โ โโโ Footer.jsx # Footer with organization info
โโโ App.jsx # Main app component
โโโ App.css # Global styles
Made with ๐ by SheCodesOKC
Happy contributing! ๐โจ๐ฉโ๐ป