|
| 1 | +## How to Contribute |
| 2 | + |
| 3 | +We welcome contributions to JS Learning Lab! Here are several ways you can help: |
| 4 | + |
| 5 | +### 🎯 Adding Questions |
| 6 | + |
| 7 | +The easiest way to contribute is by adding new JavaScript questions: |
| 8 | + |
| 9 | +1. **Use the Admin Interface** |
| 10 | + - Open `admin.html` in your browser |
| 11 | + - Fill out the question form with all details |
| 12 | + - Generate the JSON and copy it |
| 13 | + - Add to `src/data/questionsDatabase.json` |
| 14 | + |
| 15 | +2. **Question Guidelines** |
| 16 | + - Focus on real-world JavaScript scenarios |
| 17 | + - Include clear, detailed explanations |
| 18 | + - Provide helpful hints for learning |
| 19 | + - Test your questions thoroughly |
| 20 | + - Use proper grammar and formatting |
| 21 | + |
| 22 | +### 🛠️ Code Contributions |
| 23 | + |
| 24 | +1. **Fork the Repository** |
| 25 | + ```bash |
| 26 | + git clone https://github.com/SyntaxSidekick/js-learning-lab.git |
| 27 | + cd js-learning-lab |
| 28 | + ``` |
| 29 | + |
| 30 | +2. **Create a Feature Branch** |
| 31 | + ```bash |
| 32 | + git checkout -b feature/your-feature-name |
| 33 | + ``` |
| 34 | + |
| 35 | +3. **Make Your Changes** |
| 36 | + - Follow the existing code style |
| 37 | + - Add tests if applicable |
| 38 | + - Update documentation as needed |
| 39 | + |
| 40 | +4. **Test Your Changes** |
| 41 | + ```bash |
| 42 | + npm install |
| 43 | + npm run dev |
| 44 | + ``` |
| 45 | + |
| 46 | +5. **Commit and Push** |
| 47 | + ```bash |
| 48 | + git add . |
| 49 | + git commit -m "Add: your feature description" |
| 50 | + git push origin feature/your-feature-name |
| 51 | + ``` |
| 52 | + |
| 53 | +6. **Create a Pull Request** |
| 54 | + - Describe your changes clearly |
| 55 | + - Include screenshots if applicable |
| 56 | + - Reference any related issues |
| 57 | + |
| 58 | +### 📋 Development Standards |
| 59 | + |
| 60 | +- **Code Style**: Follow existing patterns and use ESLint |
| 61 | +- **Commits**: Use clear, descriptive commit messages |
| 62 | +- **Documentation**: Update README.md and comments as needed |
| 63 | +- **Testing**: Test all functionality before submitting |
| 64 | + |
| 65 | +### 🐛 Reporting Issues |
| 66 | + |
| 67 | +- Use GitHub Issues to report bugs |
| 68 | +- Include steps to reproduce |
| 69 | +- Provide browser and system information |
| 70 | +- Include screenshots if helpful |
| 71 | + |
| 72 | +### 💡 Feature Requests |
| 73 | + |
| 74 | +- Open a GitHub Discussion for feature ideas |
| 75 | +- Explain the use case and benefits |
| 76 | +- Consider implementing it yourself! |
| 77 | + |
| 78 | +Thank you for contributing to JS Learning Lab! 🚀 |
0 commit comments