Contributing¶

This section provides guidelines for contributing to the volnux project.

Getting Started¶

We welcome contributions! Here’s how you can help improve the volnux library:

Fork the repository
Create a new branch for your changes
Make your changes
Submit a pull request

Development Setup¶

Clone the repository:

git clone https://github.com/nshaibu/volnux.git
cd volnux

Create a virtual environment:

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

Install development dependencies:

pip install -r requirements-tests.txt
pip install -r requirements-build.txt

Running Tests¶

Run the test suite:

pytest

For coverage report:

pytest --cov=volnux --cov-report=html

Code Style¶

We use Black for code formatting:

black volnux

Documentation¶

To build the documentation:

Install Sphinx:
```
pip install sphinx sphinx-rtd-theme
```
Build the docs:
```
cd docs
make html
```

The built documentation will be in docs/build/html.

Making Changes¶

Create a new branch:
```
git checkout -b feature-name
```
Make your changes
Add tests for new functionality
Update documentation as needed
Run the test suite

Commit your changes:

git add .
git commit -m "Description of changes"

Push to your fork:
```
git push origin feature-name
```
Create a Pull Request

Pull Request Guidelines¶

Include tests for new functionality
Update documentation for changes
Follow the existing code style
Add an entry to CHANGELOG.md
Keep commits focused and atomic

Reporting Issues¶

When reporting issues, please include:

Detailed description of the issue
Steps to reproduce
Expected vs actual behavior
Version information: - Python version - volnux version - OS version
Any relevant logs or error messages

License¶

By contributing, you agree that your contributions will be licensed under the GNU GPL-3.0 License.