Contributing¶

Thank you for your interest in contributing to hipo-utils!

Getting Started¶

1. Fork the repository on GitLab
2. Clone your fork locally
3. Create a feature branch

Development Setup¶

git clone git@code.jlab.org:YOUR_USERNAME/hipo-utils.git
cd hipo-utils
meson setup build --buildtype=debug
meson compile -C build

Code Style¶

• Follow the existing code style
• Use modern C++20 features where appropriate
• Add appropriate error handling
• Include --no-color support for all tools

Adding a New Tool¶

1. Create source file in src/hipo_newtool.cpp
2. Add executable definition in meson.build
3. Add documentation in docs/tools/hipo-newtool.md
4. Update docs/tools/index.md and mkdocs.yml navigation
5. Add entry to README.md

Testing¶

# Run tests
meson test -C build

Documentation¶

Documentation is built with MkDocs. To preview locally:

pip install -r requirements-docs.txt
mkdocs serve

Then visit http://127.0.0.1:8000

Submitting Changes¶

1. Ensure code compiles without warnings
2. Update documentation if needed
3. Push to your fork
4. Create a Merge Request on GitLab

License¶

By contributing, you agree that your contributions will be licensed under the WTFPL license.