Contributing¶
Thank you for your interest in contributing to Live Audio Capture! We welcome contributions from everyone, whether you're fixing a bug, adding a feature, or improving documentation.
Getting Started¶
- Fork the repository on GitHub.
- Clone your fork to your local machine:
git clone https://github.com/sami-rajichi/live_audio_capture.git
- Create a new branch for your changes:
git checkout -b your-branch-name
Setting Up the Development Environment¶
- Install Python: Ensure you have Python 3.9 or higher installed.
- Install Dependencies:
pip install -r requirements.txt pip install -e .
- Install FFmpeg: Follow the installation instructions in the Installation Guide.
Making Changes¶
- Follow the Project Structure:
- Code lives in the
live_audio_capture/
directory. - Tests are in the
tests/
directory. - Examples are in the
examples/
directory. - Write Clear and Concise Code: Ensure your code is easy to read and understand.
- Add Documentation: Update the relevant documentation if your changes introduce new features or modify existing behavior.
Submitting a Pull Request¶
- Push Your Changes:
git push origin your-branch-name
- Open a Pull Request:
- Go to the GitHub repository.
- Click New Pull Request.
- Select your branch and provide a clear description of your changes.
- Address Feedback: Be responsive to feedback and make necessary updates to your pull request.
Thank You!¶
Your contributions help make Live Audio Capture better for everyone. We appreciate your time and effort!