Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
154 lines (111 loc) · 3.78 KB

CONTRIBUTING.md

File metadata and controls

154 lines (111 loc) · 3.78 KB

🚀 Contributing to ProjectHive

Hacktoberfest Contributors PRs Welcome

🎉 Join our amazing community of developers!

👥 Contributors

Made with contrib.rocks

⚡ Quick Start (5 Steps)

  1. Fork the repository and clone your fork:
git clone https://github.com/YOUR-USERNAME/ProjectHive.git
cd ProjectHive
  1. Create a new branch:
git checkout -b my-awesome-project
  1. Add your project
  • Create a folder for your project under the correct domain:
    • Domains//MiniProjects/YourProjectName
  • Add all code files (HTML, CSS, JS, etc.) inside the project folder.
  • MUST include a README.md inside your project folder with the template below.

README.md template:

# Your Project Name
**Contributor:** YourGitHubUsername

## Description
Short description of what your project does.

## How to Run
1. Steps to install/run
2. Example commands
  1. Commit & push:
git add .
git commit -m "Add: [Domain] Your Project Name"
git push -u origin my-awesome-project
  1. Open a Pull Request
  • Go to your fork on GitHub and click "New Pull Request".
  • Fill PR description with what you added and any setup instructions.

After merge: Your name will automatically appear on the leaderboard.

📦 What You Can Contribute

  • Mini-Projects — Full working apps
    Location: Domains/[Domain]/MiniProjects/
  • Templates — Starter boilerplates
    Location: Domains/[Domain]/Starter-Templates/
  • Roadmaps — Learning paths and guides
    Location: Domains/[Domain]/Roadmap.md

✅ Contribution Rules

DO

  • Add working code (not just markdown for project entries).
  • Include Contributor: YourUsername in your project's README.md.
  • Test your code before submitting.
  • Use clear and descriptive commit messages.

DON'T

  • Submit only markdown files without actual project code.
  • Use placeholder names like "YourUsername".
  • Copy others' work without credit.
  • Add spam or low-quality content.

Important: You will not be credited on the leaderboard unless your project's README includes "Contributor: YourUsername".

🎯 Commit Message Examples

Use this format: Type: [Domain] Description

  • Add: Frontend - Todo App with React
  • Update: Backend - Enhanced API documentation
  • Fix: AI-ML - Corrected model training script

🌐 Available Domains

  • 🤖 AI-ML
  • 🥽 AR-VR
  • ⚙️ Backend
  • ⛓️ Blockchain
  • ☁️ Cloud
  • 🔐 Cybersecurity
  • 🔧 DevOps
  • 🎨 Frontend
  • 🌟 FullStack
  • 📡 IoT
  • 🧠 MLOps
  • 💬 NLP
  • 🤖 Robotics

🏆 Recognition

Every merged PR:

  • Adds you to the Overall Leaderboard
  • Features you in Hall of Fame (Top 10)
  • Shows your profile in the contributors section

🤝 Code of Conduct

  • Be respectful and inclusive.
  • Help others learn and provide constructive feedback.
  • No spam, harassment, or plagiarism.

📚 Need More Help?

  • Quick Start Guide — Get started in 5 minutes.
  • Contributor Tag Examples — See correct formats.
  • Leaderboard Guide — How recognition works.
  • Discussions — Ask questions in the repository Discussions.
❤️ Thank you for making ProjectHive better!