Contributing
AutoHS welcomes bug reports, documentation improvements, and pull requests.
Report issues
Open a GitHub issue with:
AutoHS version (
python run.py --version)Full command line and runtime (Docker / Apptainer / source)
Last ~50 lines of relevant logs
Development setup
git clone https://github.com/phindagijimana/AutoHS.git
cd AutoHS
pip install -r requirements-bids.txt
pip install -r workflow/requirements.txt
Run tests
export PYTHONPATH="$PWD"
python -m unittest discover -s workflow/tests -p 'test_*.py' -v
Build documentation locally
pip install -r docs/requirements.txt
sphinx-build -W -b html docs/source docs/_build/html
Documentation changes
User-facing prose lives in
docs/source/(reStructuredText).Keep science and thresholds on Background and theory only; link from other pages.
Keep run examples on Quick Start; Installation covers install and architecture.
Update
CHANGELOG.mdanddocs/source/changes.rstwhen releasing.
Pull requests
Fork and branch from
main.Run the test suite (above).
If you change docs, run
sphinx-build -W.Describe what changed and how you tested it.
Maintainers: see Maintaining AutoHS for release and ecosystem steps.