Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (59 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

86 lines (59 loc) · 1.93 KB

Contributing to Voice Assistant

Thank you for your interest in contributing to the Voice Assistant project!

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
  • Your environment (OS, Python version, etc.)

Suggesting Enhancements

Feature requests are welcome! Please:

  • Check existing issues first
  • Describe the feature and its use case
  • Explain why it would be beneficial

Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests (pytest tests/ -v)
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to your branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

# Clone your fork
git clone https://github.com/hasancoded/voice-assistant.git
cd voice-assistant

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Set up environment variables
cp .env.example .env
# Edit .env with your API keys

# Run tests
pytest tests/ -v

# Run the application
python -m src.app

Code Style

  • Follow PEP 8 guidelines
  • Use meaningful variable names
  • Add docstrings to functions and classes
  • Keep functions focused and concise
  • Add type hints where appropriate

Testing

  • Write tests for new features
  • Ensure all tests pass before submitting PR
  • Aim for good test coverage

Commit Messages

  • Use clear, descriptive commit messages
  • Start with a verb (Add, Fix, Update, Remove, etc.)
  • Keep the first line under 50 characters
  • Add details in the message body if needed

Questions?

Feel free to open an issue for any questions about contributing.

License

By contributing, you agree that your contributions will be licensed under the MIT License.