Contributing

We welcome contributions to NeuRodent! This guide will help you get started.

Quick Start

git clone https://github.com/josephdong1000/neurodent.git
cd neurodent
make setup  # Requires uv

Setup Guide

Environment setup, prerequisites, pre-commit hooks, and Makefile commands.

Development Setup

Testing & Development

Running tests, building documentation, and code style guidelines.

Testing & Development

Pull Request Process

1. Fork the repository and create a new branch for your feature or bug fix

2. Make your changes and add tests if applicable

3. Ensure all tests pass and documentation builds successfully

4. Submit a pull request with a clear description of the changes

Questions?

If you have questions, please open an issue on the GitHub repository.