CONTRIBUTING.md

How to Contribute

We welcome contributions to JS Learning Lab! Here are several ways you can help:

🎯 Adding Questions

The easiest way to contribute is by adding new JavaScript questions:

1. Use the Admin Interface

   • Open admin.html in your browser
   • Fill out the question form with all details
   • Generate the JSON and copy it
   • Add to src/data/questionsDatabase.json

2. Question Guidelines

   • Focus on real-world JavaScript scenarios
   • Include clear, detailed explanations
   • Provide helpful hints for learning
   • Test your questions thoroughly
   • Use proper grammar and formatting

🛠️ Code Contributions

1. Fork the Repository

   git clone https://github.com/SyntaxSidekick/js-learning-lab.git
   cd js-learning-lab

2. Create a Feature Branch

   git checkout -b feature/your-feature-name

3. Make Your Changes

   • Follow the existing code style
   • Add tests if applicable
   • Update documentation as needed

4. Test Your Changes

   npm install
   npm run dev

5. Commit and Push

   git add .
   git commit -m "Add: your feature description"
   git push origin feature/your-feature-name

6. Create a Pull Request

   • Describe your changes clearly
   • Include screenshots if applicable
   • Reference any related issues

📋 Development Standards

• Code Style: Follow existing patterns and use ESLint
• Commits: Use clear, descriptive commit messages
• Documentation: Update README.md and comments as needed
• Testing: Test all functionality before submitting

🐛 Reporting Issues

• Use GitHub Issues to report bugs
• Include steps to reproduce
• Provide browser and system information
• Include screenshots if helpful

💡 Feature Requests

• Open a GitHub Discussion for feature ideas
• Explain the use case and benefits
• Consider implementing it yourself!

Thank you for contributing to JS Learning Lab! 🚀