Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (40 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

50 lines (40 loc) · 1.85 KB
Raw

Contributing to CodeLab

Thank you for your interest in contributing to CodeLab! We are building one of the world's best, free, open-source programming learning platforms.

By contributing, you help make software engineering education accessible to students, self-learners, developers, and teachers worldwide.

🗺️ Contributor Roadmap & Journey

1. Becoming a Contributor

  • Anyone is welcome to contribute! You do not need to be a senior developer.
  • Review existing issues or propose a new concept by creating a Feature Request.
  • Follow our Code of Conduct in all community interactions.

2. Making Your First Contribution

  1. Fork the Repository: Create your own copy of this project on GitHub.
  2. Clone Locally: 
    git clone https://github.com/YOUR-USERNAME/CodeLab.git
cd CodeLab
  3. Create a Feature Branch: 
    git checkout -b feature/topic-name
  4. Follow our Coding Standards & Lesson Structure:
    • Every lesson must follow our 10-section structure (Introduction, Theory, Syntax, etc.).
    • Code samples must compile, contain rich comments, and have no placeholder text.
  5. Commit & Push: 
    git add .
git commit -m "feat(topic): add basic lesson for topic"
git push origin feature/topic-name
  6. Open a Pull Request: Submit your PR details against our main branch.

🛠️ Code Review Process

  • All submissions are verified against our automated GitHub Actions (linting, link validity, spell checking).
  • Maintainers review code structure, comments, and readability.
  • Once approved, your changes will be merged into the next release!

📜 Community Etiquette

  • Be respectful, welcoming, and encouraging of beginners.
  • Provide constructive feedback during code reviews.
  • Ask questions and share knowledge in our GitHub Discussions!