Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (41 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

68 lines (41 loc) · 2.22 KB

Contributing to EliteInterns – Web Dev Internship

Thank you for considering contributing to the EliteInterns open-source learning repository! Whether you're fixing a typo, improving code, or adding new content, your input helps make this project better for all learners.

📌 Before You Start

Please make sure to read this document fully before submitting a pull request.

This project is designed to:

  • Help learners understand web development fundamentals
  • Provide real-world examples of HTML, CSS, JS, and libraries
  • Showcase mini-projects built during internship sessions

💡 Ways You Can Contribute

  • 🔧 Fix bugs or broken links in notes, demos, or projects
  • 🖋 Improve explanations or add missing steps in notes
  • 🧱 Add a new project or library demo
  • 🎨 Enhance UI/UX of existing pages (but keep it beginner-friendly)
  • 📄 Suggest improvements via GitHub Issues

🛠 Folder Structure Guidelines

  • Place new notes in the appropriate folder inside /notes/
  • Library demos go into /libraries/Library-Name/
    Include: index.html, script.js, style.css, and optionally data.json
  • Projects go into /projects/Project-Name/ with clean folder structure

✅ Contribution Checklist

Before submitting a pull request, make sure to:

  1. ✅ Fork the repository
  2. ✅ Create a new branch: git checkout -b your-feature-name
  3. ✅ Write clear commit messages
  4. ✅ Ensure your code is well-formatted and working
  5. ✅ Add demo links in the README (if needed)
  6. ✅ Push and create a pull request (PR)

📄 Pull Request Format

When opening a pull request:

  • Give a clear title (e.g., "Add Weather Dashboard project")
  • In the description, include:
    • What was added/changed
    • Screenshot or link to preview (if applicable)
    • Any related issue number (e.g., Closes #12)

Code of Conduct

We follow a friendly and inclusive environment for learning and collaboration.

Be respectful, constructive, and helpful. See our Code of Conduct for details.

🙌 Thanks!

Thank you for making this project better. Your efforts help thousands of learners grow and build cool stuff! 🚀

Happy coding,
– The EliteInterns Team