CONTRIBUTING.md

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

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

2. Create a feature branch

   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

   # Run the application
   cd backend
   uvicorn main:app --reload
   
   # Test with various prompts
   

5. Commit with clear messages

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

6. Push and create PR

   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 for setup instructions.

Questions?

Feel free to open an issue for any questions!

---

Thank you for making Sikho better! 🙏