We welcome contributions to cfxdb! This guide explains how to get involved.
- GitHub Issues: Report bugs or request features at https://github.com/crossbario/cfxdb/issues
- GitHub Discussions: Ask questions and discuss at https://github.com/crossbario/cfxdb/discussions
When reporting issues, please include:
- Python version (
python --version) - cfxdb version (
python -c "import cfxdb; print(cfxdb.__version__)") - Operating system and version
- zLMDB/LMDB version if relevant
- Minimal code example reproducing the issue
- Full traceback if applicable
- Fork the repository on GitHub
- Create a feature branch from
master - Make your changes following the code style
- Add tests for new functionality
- Run the test suite to ensure nothing is broken
- Submit a pull request referencing any related issues
git clone https://github.com/crossbario/cfxdb.git
cd cfxdb
pip install -e .[dev]# Run all tests
tox
# Run tests for specific Python version
tox -e py312- Follow PEP 8
- Use meaningful variable and function names
- Add docstrings for public APIs
- Keep lines under 100 characters
By contributing to cfxdb, you agree that your contributions will be licensed under the MIT License.