File size: 1,787 Bytes
a5e880f
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
b6e0003
a5e880f
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# Contributing to Sikho

Thank you for your interest in contributing to Sikho! We welcome contributions from the community.

## How to Contribute

### Reporting Bugs

If you find a bug, please create an issue with:

- Clear description of the problem
- Steps to reproduce
- Expected vs actual behavior
- Environment details (OS, Python version, etc.)

### Suggesting Features

Feature suggestions are welcome! Please:

- Check existing issues first
- Provide clear use case
- Explain expected behavior
- Include examples if possible

### Pull Requests

1. **Fork the repository**

   ```bash
   git clone https://github.com/SayedZahur786/Animetrix_AI.git
   ```

2. **Create a feature branch**

   ```bash
   git checkout -b feature/your-feature-name
   ```

3. **Make your changes**

   - Follow existing code style
   - Add comments for complex logic
   - Update documentation if needed

4. **Test your changes**

   ```bash
   # Run the application
   cd backend
   uvicorn main:app --reload

   # Test with various prompts
   ```

5. **Commit with clear messages**

   ```bash
   git commit -m "Add: description of your changes"
   ```

6. **Push and create PR**
   ```bash
   git push origin feature/your-feature-name
   ```

## Code Style

- Follow PEP 8 for Python code
- Use meaningful variable names
- Add docstrings for functions
- Keep functions focused and small

## Areas for Contribution

- 🎨 Frontend improvements
- πŸ€– Additional AI model integrations
- 🎬 New animation effects
- πŸ“š Documentation enhancements
- πŸ› Bug fixes
- ⚑ Performance optimizations
- πŸ§ͺ Test coverage

## Development Setup

See [README.md](README.md) for setup instructions.

## Questions?

Feel free to open an issue for any questions!

---

Thank you for making Sikho better! πŸ™