Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (56 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

82 lines (56 loc) · 2.15 KB

Contributing to 100 JavaScript Projects 🚀

Thank you for your interest in contributing to 100 JavaScript Projects! Whether you're a beginner or an experienced developer, your input is highly valued. 🙌

🧠 Project Goal

This repository aims to provide 100 fun and practical JavaScript project examples to help developers strengthen their JavaScript skills by building real-world applications.

📌 How to Contribute

There are several ways you can contribute:

💡 Suggest a Project Idea

  • Open an issue with the title: Project Idea: [Your Idea]
  • Add a description of the project and any features you’d like to see included.

🔧 Add a New Project

  1. Fork the repository

  2. Create a new branch:

    git checkout -b feature/project-name

  3. Create a new folder inside projects/ with your project name.

  4. Add your project files (HTML, CSS, JS, assets).

  5. Add a README.md explaining:

    • Project title
    • Description
    • Features
    • How to run

  6. Commit and push your changes:

    git add .
git commit -m "Add [Project Name] project"
git push origin feature/project-name

  7. Open a Pull Request and briefly describe your addition.

📝 Improve Documentation

  • Fix typos, grammar, or formatting issues
  • Add helpful instructions or explanations

✅ Code Guidelines

  • Use vanilla JavaScript (no frameworks unless the project specifically calls for it).

  • Keep code clean, readable, and well-commented.

  • Stick to standard project structure:

    projects/
  project-name/
    index.html
    style.css
    script.js
    README.md

  • Use meaningful commit messages.

🙏 Code of Conduct

Please be respectful and considerate of others. We follow the Contributor Covenant Code of Conduct.

📬 Need Help?

If you're unsure how to get started or want to discuss an idea, feel free to open an issue or reach out on Discussions (if enabled).

Happy Coding! 💻✨

— *Pradip Chaudhary*