Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (76 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

94 lines (76 loc) · 3.05 KB

Contributing to Namaste JavaScript Notes

Thank you for your interest in contributing to this project! 🚀

How to Contribute

🐛 Reporting Issues

  • Check if the issue already exists in the Issues section
  • Provide clear descriptions of any errors or improvements needed
  • Include specific episode numbers and line references when applicable

📝 Suggesting Improvements

  • Content Corrections: Spotted a typo or technical error? Please let us know!
  • Additional Examples: Have a better code example or explanation? Share it!
  • Interview Questions: Know great interview questions related to the topics? Add them!

🔧 Making Changes

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch for your changes: 
    git checkout -b feature/your-improvement-name
  4. Make your changes following our guidelines below
  5. Test your changes (ensure markdown renders correctly)
  6. Commit with a clear message: 
    git commit -m "Add: explanation for closure edge case in EP_10"
  7. Push to your fork and create a Pull Request

📋 Content Guidelines

Writing Style

  • Keep explanations clear and beginner-friendly
  • Use code comments extensively in examples
  • Include real-world scenarios where applicable
  • Add interview-style Q&A sections

Code Format

// ✅ Good: Clear comments explaining the concept
function example() {
    // This demonstrates hoisting behavior
    console.log(myVar); // undefined (not an error)
    var myVar = 5;
}

// ❌ Avoid: Uncommented or unclear code
function example() {
    console.log(myVar);
    var myVar = 5;
}

Markdown Structure

  • Use proper headings hierarchy (H1 → H2 → H3)
  • Include code blocks with language specification
  • Add emojis sparingly for better readability
  • Keep line length reasonable (under 100 characters when possible)

Episode Structure

Each episode should follow this structure:

  1. Introduction - What the episode covers
  2. Detailed Explanation - Core concepts with examples
  3. Code Examples - Practical demonstrations
  4. Interview Questions - Common interview scenarios
  5. Key Takeaways - Summary points

🚫 What NOT to Include

  • Copyrighted content without permission
  • Overly complex examples for basic concepts
  • Unrelated JavaScript topics not covered in Namaste JavaScript series
  • Personal opinions without technical backing

📞 Questions?

  • Open an Issue for general questions
  • Reference specific episodes when asking questions
  • Be respectful and constructive in all communications

🎯 Priority Areas

We especially welcome contributions in:

  • Code examples improvements
  • Interview questions additions
  • Typo corrections and clarity improvements
  • Visual diagrams or illustrations
  • Edge cases and advanced scenarios

Thank you for helping make JavaScript learning better for everyone! 🙏

Remember: Every small contribution matters. Even fixing a single typo helps thousands of learners!