Skip to content

Contributing to LimbLab

Thanks for your interest in contributing to LimbLab! Since this is a personal project, any and all help is welcome and greatly appreciated. Here are a few ways you can contribute.

Reporting Bugs or Suggesting Ideas

The easiest way to contribute is to open an issue on GitHub.

  • Found a bug? Let me know what you were doing, what you expected to happen, and what actually happened. Error messages are especially helpful!
  • Have a new idea? I'd love to hear it. Feel free to suggest new features or improvements.

Contributing Code or Documentation

If you'd like to write code or fix a typo in the documentation, that's fantastic!

Setup

  1. Fork and clone the repository: 

    git clone https://github.com/YOUR_USERNAME/limblab.git
cd limblab

  2. Set up a virtual environment: 

    python -m venv limblab_dev
source limblab_dev/bin/activate  # On Windows: limblab_dev\Scripts\activate

  3. Install the dependencies: 

    pip install -e ".[dev]"

Making a Pull Request

  1. Create a new branch: 

    git checkout -b your-cool-feature

  2. Make your changes. Try to match the existing code style, but don't worry about getting everything perfect.

  3. Submit a pull request. I'll review it as soon as I can.

Questions?

If you have any questions, feel free to reach out:

Thanks again for your help!