Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
111 lines (75 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

111 lines (75 loc) · 2.6 KB

🤝 Contributing to JavaScript Vault

Welcome, contributor! 🚀
We're thrilled to have you here. This repository is a curated collection of high-quality JavaScript projects under the HashSlap Summer of Code (HSSoC).

Please read this guide before opening a pull request.

📌 Contribution Rules

🔥 We’re only accepting quality projects — please submit your best JavaScript work, not beginner-level exercises.

✅ What You Can Submit:

  • Useful, unique, or production-ready JavaScript projects
  • Tools, scripts, extensions, games, visualizations, etc.
  • Node.js CLI utilities
  • React, Vue, Svelte projects (well-structured and documented)
  • Projects with meaningful functionality

❌ What Will Be Rejected:

  • Basic beginner projects (calculator, to-do list, counter, etc.)
  • Forks/clones of popular projects without meaningful changes
  • Incomplete or broken code
  • No README or unclear structure
  • Copied content without credit

🛠️ How to Contribute

1. Fork the Repository

Click on the "Fork" button at the top-right corner to create your own copy.

2. Clone Your Fork Locally

git clone https://github.com/<your-username>/javascript-vault.git
cd javascript-vault

3. Create a New Branch

git checkout -b add/my-awesome-project

4. Add Your Project

  • Create a folder under projects/<category>/your-project-name/
  • Add your project files inside it
  • Add a proper README.md (template below)
  • Use semantic folder names and camel/kebab-case

5. Commit and Push

git add .
git commit -m "✨ Add [Your Project Name]"
git push origin add/my-awesome-project

6. Submit a Pull Request

  • Go to the original repository
  • Click “Compare & Pull Request”
  • Add a meaningful description
  • We’ll review your submission and merge if it meets the standards

📘 README Template

Your project must include a README.md explaining:

# Project Title

## 🚀 Overview
Brief summary of the project and what it does.

## 🔧 Features
- Feature 1
- Feature 2

## 🛠️ Tech Stack
- JavaScript (ES6+)
- [Frameworks/libraries used]

## 📦 How to Run
Steps to install and run your project.

## 📸 Screenshots (Optional)
Visuals/GIFs showing the app in action.

## 📜 License (Optional)
Mention if it’s open-source or MIT.

💬 Community & Support

Join our Discord to ask questions, get help, or brainstorm project ideas!

Made with 💙 by HashSlap Summer of Code Let's build something awesome together.