Skip to content

contributions.md

Latest commit

 

History

History
102 lines (72 loc) · 3 KB

contributions.md

File metadata and controls

102 lines (72 loc) · 3 KB

🤝 Vibe Coding Contributions Guide

Welcome to the official Vibe Coding repository — a collaborative coding space where we come together to solve simple but meaningful problems for the community. Whether it's a tool to save time, a quirky idea that helps a friend, or an automation that makes life easier — if it solves something, it's welcome here.

🧩 What Is This?

This repo is a collection of mini-projects built live during the Vibe Coding Event with ~80–100 passionate developers. Each of us picked a problem and tried to solve it creatively. All projects live side by side, documented, and open to the world.

🗂 Folder Structure

Each project must have its own folder in the root of this repo. Here's the structure to follow:


/vibe-coding-repo
│
├── project-name/
│   ├── README.md
│   ├── code/
│   └── assets/ (optional)
│
├── another-project/
│   ├── README.md
│   ├── code/
│   └── assets/
│
└── contributions.md

📛 Folder Naming Convention

  • Use kebab-case for folder names.
  • Keep names short, descriptive, and unique.
  • Examples: habit-tracker, ai-resume-helper, water-reminder-bot

🚀 How to Contribute

  1. Fork this repository.
  2. Create a new folder at the root for your project.
  3. Inside your project folder:
    • Add a README.md with the following:
      • ✅ Problem Statement
      • 🛠 Tech Stack
      • 📦 Setup / Run Instructions
      • 👥 Contributors
    • Add your code inside a code/ folder.
    • Add images or assets (optional) in assets/.
  4. Commit & Push your changes.
  5. Open a Pull Request (PR) with a title like:

Added \[project-name]: \[short description]

📌 Guidelines

  • Keep your code clean and well-commented.
  • Respect other contributors — collaboration > competition.
  • Each project should be self-contained.
  • Reuse common libraries/tools where possible.
  • Document thoroughly. Your README is the gateway to your idea.

💡 Inspiration Board

Don’t know what to build? Here are some ideas:

  • A CLI-based TODO tracker
  • LinkedIn content idea generator
  • Local public event aggregator
  • Expense logger that exports to Excel
  • Auto WhatsApp reminder tool
  • Chrome extension to block distractions
  • GPT-powered meme generator
  • Small game using JavaScript

🙌 Credits

This repository is a result of the collective energy at Vibe Coding, an event where developers from all backgrounds come together to build, learn, and vibe together.

Event Organizer: Shreyan Mehta
Date: Tomorrow (June 7, 2025)
Community: GDG Gandhinagar, GDG Cloud Gandhinagar
LinkedIn: LinkedIn
Contact: developershreyan@gmail.com

Let’s build things that solve real problems, no matter how small.
Let’s vibe and code! 💻🎧🚀