Animetrix_AI / CONTRIBUTING.md
SayedZahur786's picture
Added Deployment Specific Files for Hugging Face Spaces
b6e0003
# 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! πŸ™