Contributing

Thank you for your interest in contributing to AnalysisG!

How to Contribute

There are many ways to contribute to the AnalysisG framework:

If you find a bug or have a feature request:

Check if the issue already exists in the GitHub issue tracker
Create a new issue with a clear description
Include relevant information:
- AnalysisG version
- Operating system
- Steps to reproduce (for bugs)
- Expected vs actual behavior

git clone https://github.com/your-username/AnalysisG.git
cd AnalysisG

mkdir build
cd build
cmake ..
make

Follow the existing code style:

Update documentation when:

Documentation is located in:

Ensure your changes don’t break existing functionality:

git checkout -b feature/my-feature

git commit -m "Add feature: description"

git push origin feature/my-feature

Documentation improvements are always welcome:

To build documentation:

cd docs
doxygen ../Doxyfile
make html

View the result in docs/_build/html/index.html.

Be respectful and professional in all interactions. We aim to create a welcoming and inclusive environment for all contributors.

If you need help:

By contributing, you agree that your contributions will be licensed under the same license as the project.

Contributors will be acknowledged in the project. Significant contributions may be recognized in release notes and documentation.

For questions about contributing, please open an issue on GitHub or contact the maintainers.

Your contributions help make AnalysisG better for everyone!