Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (69 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

96 lines (69 loc) · 2.18 KB

Contributing to btaudio

Thank you for your interest in contributing to btaudio! This document provides guidelines and instructions for contributing.

Code of Conduct

  • Be respectful and inclusive
  • Welcome newcomers and help them get started
  • Focus on constructive criticism
  • Respect differing opinions and experiences

How to Contribute

Reporting Issues

  1. Check existing issues to avoid duplicates
  2. Use the issue template when available
  3. Provide clear description and steps to reproduce
  4. Include system information (Linux distribution, audio system, terminal)

Suggesting Features

  1. Open an issue with [Feature Request] prefix
  2. Describe the use case and benefits
  3. Provide examples if possible

Submitting Code

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/your-feature)
  3. Make your changes
  4. Test thoroughly
  5. Commit with descriptive messages
  6. Push to your fork
  7. Open a Pull Request

Development Guidelines

Code Style

  • Use 2-space indentation
  • Keep lines under 100 characters
  • Use meaningful variable names
  • Add comments for complex logic
  • Follow existing patterns in the codebase

Testing

Before submitting:

  • Test with different Bluetooth devices
  • Test on both PipeWire and PulseAudio
  • Verify all commands work as expected
  • Check error handling

Shell Script Best Practices

  • Use shellcheck to validate scripts
  • Quote variables properly
  • Handle errors gracefully
  • Use set -euo pipefail for safety
  • Prefer [[ ]] over [ ] for conditions

Commit Messages

Format:

type: brief description

Detailed explanation if needed
- List key changes
- Reference issues if applicable

Types:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation
  • style: Formatting changes
  • refactor: Code restructuring
  • test: Test additions
  • chore: Maintenance

Development Setup

  1. Clone the repository
  2. Make btaudio executable: chmod +x bin/btaudio
  3. Link for testing: ln -s $(pwd)/bin/btaudio ~/.local/bin/btaudio-dev
  4. Test your changes

Questions?

Feel free to open an issue for questions or join discussions in existing issues.

Thank you for contributing to btaudio!

— web3dozie