Contributing
Thank you for using Phenoverse - 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:
- Phenoverse version, OS, Python version, GPU, and other relevant info
- Exact command or code snippet to reproduce the problem
- Full error message or traceback
Development setup
- Fork the repo on GitHub and clone your fork:
git clone https://github.com/KellisLab/Phenoverse.git cd Phenoverse - Create an isolated environment (e.g. Mamba)
- Install Phenoverse in editable mode:
pip install -e .
Making changes
- Work on a feature branch:
git checkout -b feature/short-description - Please write clear commit messages
- Update documentation if the user-facing interface changes
License
By contributing, you agree your contributions are licensed under the project's MIT License.