Skip to content

Contributing to PhosphoVelocity

First off, thank you for considering contributing to PhosphoVelocity! We welcome contributions from the community, whether it's reporting a bug, proposing a new feature, improving documentation, or submitting a pull request.

This document outlines the process for contributing to the project.

🐛 Reporting Issues

If you find a bug or have a feature request, please open an issue on our GitHub Issues page.

When reporting a bug, please include:

  • A clear and descriptive title.
  • The version of PhosphoVelocity and Python you are using.
  • A minimal reproducible example (code snippet or dummy data) if applicable.
  • The expected behavior vs. the actual behavior.
  • Full tracebacks for any errors.

When requesting a feature, please include:

  • A clear description of the proposed feature.
  • The scientific or computational rationale for the feature.
  • Any relevant references to literature if it involves new mathematical or statistical models.

💻 Local Development Setup

To contribute code or documentation, you will need to set up a local development environment.

1. Fork and Clone

Fork the repository to your own GitHub account, and then clone it locally:

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