Skip to content

Latest commit

 

History

History
98 lines (68 loc) · 2.19 KB

File metadata and controls

98 lines (68 loc) · 2.19 KB

⚡ Quick Start - Contributing in 5 Minutes

1️⃣ Setup (One-time)

# Fork the repo on GitHub, then:
git clone https://github.com/YOUR-USERNAME/ProjectHive.git
cd ProjectHive

2️⃣ Create Your Project

Choose a domain (e.g., Frontend, Backend, AI-ML, etc.)

# Create a new branch
git checkout -b add-my-project

# Go to your domain
cd Domains/YourDomain/MiniProjects/

# Create a folder for your project
mkdir MyAwesomeProject
cd MyAwesomeProject

3️⃣ Add Your Code

Add ALL your project files:

  • index.html, style.css, script.js (for web projects)
  • app.py, requirements.txt (for Python)
  • server.js, package.json (for Node.js)
  • Whatever files your project needs!

Important: Create a README.md with:

# Your Project Name
**Contributor:** YourGitHubUsername

## What it does
Brief description

## Tech Stack
- List your technologies

## How to run
1. Step one
2. Step two

4️⃣ Submit

git add .
git commit -m "Add: MyAwesomeProject in YourDomain"
git push origin add-my-project

Then create a Pull Request on GitHub!

✅ That's It!

Once merged, you'll automatically appear on the leaderboard!


💡 Example Projects to Learn From

  • Frontend: Domains/Frontend/MiniProjects/TodoApp/
  • Backend: Domains/Backend/MiniProjects/SimpleAPI/
  • AI-ML: Domains/AI-ML/MiniProjects/SentimentAnalyzer/
  • FullStack: Domains/FullStack/MiniProjects/TaskManagerApp/
  • Algorithms: Domains/CompetitiveProgramming/Programs/

Copy their structure and adapt for your project!


� Common Mistakes

❌ Only creating a README without actual code
❌ Forgetting to add **Contributor:** YourUsername
❌ Not testing code before submitting
❌ Modifying other people's projects

✅ Create a complete working project with all files
✅ Include contributor tag in README
✅ Test everything works
✅ Add your own new project


📚 Need More Help?