📖 Contributing

Thank you for using Hydra - We welcome bug fixes, documentation improvements, and other new features.

Ways to contribute

• Report bugs in the issue tracker
• Improve the documentation by fixing typos, clarifying steps, or adding examples

Reporting an issue

Before opening a new issue, search existing issues to avoid duplicates. If you are considering opening an issue, please include:

• Hydra version, OS, Python and R versions, GPU and other relevant info
• Exact code snippet to reproduce the problem
• Full error message or traceback

Development setup

1. Fork the repo on GitHub and clone your fork:

   git clone https://github.com/SydneyBioX/Hydra.git
   cd Hydra
   

2. Create a isolated environment (Ex: Mamba)
3. Install Hydra in editable mode with development extras:

   pip install -e ".[dev]"
   

4. Verify your setup:

   pytest
   

Making changes

• Work on a feature branch:

  git checkout -b feature/short-description
  

• Please write clear messages before committing
• Update documentation if the user-facing interface changes

License

By contributing, you agree your contributions are licensed under the project’s MIT License.

---

Documentation by Manoj M Wagle