Contributing to AntADatabase

Contributing to AntADatabase#

We welcome and appreciate all contributions to the AntADatabase project! Whether you’re a user, developer, or researcher, there are many ways you can help improve this project.

How to Contribute#

Reporting Issues#

Found a bug or have a feature request? Please open a GitHub issue with:

  • A clear description of the problem or feature

  • Steps to reproduce (for bugs)

  • Your environment details (Python version, OS, etc.)

Code Contributions#

  1. Fork the repository on GitHub

  2. Create a feature branch from the main branch

  3. Make your changes with clear, focused commits

  4. Submit a pull request with a descriptive title and explanation

Before You Start#

  • Contact us first: Email antoine.hermant@unibe.ch to let us know what you’re working on

  • Check existing issues: Avoid duplicate work by reviewing open issues and pull requests

  • Review the Roadmap: See what’s already planned in our Roadmap

Contribution Ideas#

  • Add support for new dataset formats

  • Improve visualization capabilities

  • Enhance query performance

  • Expand documentation and examples

  • Fix bugs and improve code quality

  • Add new analysis features

Code Style#

  • Follow PEP 8 guidelines

  • Include docstrings for new functions

  • Add tests for new functionality

  • Keep commits atomic and well-documented

Thank you for helping make AntADatabase better for everyone!

Contents