Spaces:
Running
Running
| # Contributing to Saem's Tunes AI | |
| We love your input! We want to make contributing to Saem's Tunes AI as easy and transparent as possible. | |
| ## Development Process | |
| 1. Fork the repo and create your branch from `main` | |
| 2. Make your changes | |
| 3. Add tests for new functionality | |
| 4. Ensure all tests pass | |
| 5. Submit a pull request | |
| ## Code Style | |
| - Use Black for code formatting | |
| - Follow PEP 8 guidelines | |
| - Write type hints for all functions | |
| - Include docstrings for public methods | |
| - Maximum line length: 88 characters | |
| ## Testing | |
| ```bash | |
| # Run all tests | |
| pytest | |
| # Run with coverage | |
| pytest --cov=src | |
| # Run specific test file | |
| pytest tests/test_ai_system.py | |
| # Run with verbose output | |
| pytest -v | |
| ## Pull Request Process | |
| Update documentation if needed | |
| Add tests for new features | |
| Ensure CI passes | |
| Get review from maintainers | |
| Merge after approval | |
| ## Bug Reports | |
| When filing an issue, please include: | |
| Description of the problem | |
| Steps to reproduce | |
| Expected behavior | |
| Actual behavior | |
| Environment details | |
| Relevant logs | |
| ## Feature Requests | |
| We welcome feature requests! Please provide: | |
| Use case description | |
| Proposed solution | |
| Alternative solutions considered | |
| Impact on existing users | |
| ## Security Issues | |
| Please report security issues directly to security@saemstunes.com | |
| ## Questions? | |
| Contact the development team or open an issue for discussion. |