Skip to content

Commit 5ebc75c

Browse files
authored
Create CONTRIBUTING.md
1 parent 58c18c8 commit 5ebc75c

1 file changed

Lines changed: 140 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Contributing to Large Language Models Tutorial
2+
3+
Thank you for your interest in contributing! 🎉 This project aims to make LLM learning accessible to everyone.
4+
5+
## 🚀 Quick Start
6+
7+
1. **Star** ⭐ this repository if you find it helpful
8+
2. **Fork** 🍴 the repository to your account
9+
3. **Clone** your fork locally
10+
4. **Create** a new branch for your feature
11+
5. **Make** your changes
12+
6. **Test** your notebooks
13+
7. **Submit** a pull request
14+
15+
## 🛠️ How to Contribute
16+
17+
### Adding New Tutorials
18+
19+
1. **Tutorial Structure**:
20+
```
21+
Tutorial - [Topic Name].ipynb
22+
```
23+
24+
2. **Required Sections**:
25+
- Clear title and description
26+
- Learning objectives
27+
- Prerequisites
28+
- Step-by-step code with explanations
29+
- Expected outputs
30+
- Next steps/further reading
31+
32+
3. **Code Quality**:
33+
- Test all code cells
34+
- Include error handling
35+
- Add comments for complex logic
36+
- Use consistent formatting
37+
38+
### Improving Existing Content
39+
40+
- Fix typos and grammatical errors
41+
- Improve code efficiency
42+
- Add better explanations
43+
- Update deprecated libraries
44+
- Enhance visualizations
45+
46+
### Documentation
47+
48+
- Improve README sections
49+
- Add setup instructions
50+
- Create troubleshooting guides
51+
- Write FAQ entries
52+
53+
## 📝 Guidelines
54+
55+
### Notebook Standards
56+
57+
- **Clear Objectives**: Start each notebook with learning goals
58+
- **Executable Code**: All cells must run without errors
59+
- **Explanations**: Balance code with clear explanations
60+
- **Dependencies**: List all required packages
61+
- **Outputs**: Include expected outputs for key cells
62+
63+
### Code Style
64+
65+
- Follow PEP 8 for Python code
66+
- Use meaningful variable names
67+
- Add docstrings for functions
68+
- Keep cells focused and concise
69+
- Test with fresh kernel
70+
71+
### Content Guidelines
72+
73+
- **Beginner-Friendly**: Assume minimal prior knowledge
74+
- **Practical**: Focus on real-world applications
75+
- **Updated**: Use current library versions
76+
- **Ethical**: Follow AI ethics best practices
77+
78+
## 🐛 Reporting Issues
79+
80+
### Bug Reports
81+
82+
Include:
83+
- Tutorial name and cell number
84+
- Error message (full traceback)
85+
- Python version and environment
86+
- Expected vs actual behavior
87+
88+
### Feature Requests
89+
90+
Include:
91+
- Clear description of the feature
92+
- Use case or motivation
93+
- Possible implementation approach
94+
95+
## 🎯 Good First Issues
96+
97+
Look for issues labeled:
98+
- `good first issue`
99+
- `documentation`
100+
- `beginner-friendly`
101+
- `help wanted`
102+
103+
## 📊 Review Process
104+
105+
1. **Automated Checks**: Ensure notebooks run without errors
106+
2. **Code Review**: Maintainer reviews code quality
107+
3. **Content Review**: Check educational value
108+
4. **Testing**: Verify on different environments
109+
110+
## 🏆 Recognition
111+
112+
Contributors are recognized:
113+
- In the README contributors section
114+
- In release notes
115+
- On social media shout-outs
116+
117+
## 📞 Getting Help
118+
119+
- **GitHub Discussions**: For questions and ideas
120+
- **Issues**: For bugs and feature requests
121+
- **Discord**: [Join our community](https://discord.gg/yourdiscord)
122+
123+
## 📋 Checklist
124+
125+
Before submitting:
126+
127+
- [ ] Notebook runs from start to finish
128+
- [ ] All dependencies listed
129+
- [ ] Clear explanations included
130+
- [ ] Code follows style guidelines
131+
- [ ] Tests pass (if applicable)
132+
- [ ] Documentation updated
133+
134+
## 🙏 Thank You
135+
136+
Every contribution helps make LLM education more accessible. Whether it's a small typo fix or a major tutorial, your help is appreciated!
137+
138+
---
139+
140+
**Questions?** Open an issue or reach out on [Twitter](https://twitter.com/atef_ataya)!

0 commit comments

Comments
 (0)