Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (32 loc) · 984 Bytes

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 984 Bytes

Contributing to BMTool

Thank you for your interest in contributing to BMTool!

Getting Started

  1. Clone the repository:
git clone https://github.com/cyneuro/bmtool.git
cd bmtool
  1. Create a development environment:
conda create -n bmtool-dev python=3.10
conda activate bmtool-dev
  1. Install in development mode with dev dependencies:
pip install -e ".[dev]"
  1. Set up pre-commit hooks:
pre-commit install

This will automatically run code formatting and linting checks before each commit.

Making Contributions

  1. Create a new branch for your changes
  2. Make your changes and commit them
  3. Push to your branch and open a Pull Request
  4. Fill out the PR template

Pre-commit hooks will ensure your code meets our style guidelines. If any checks fail, fix the issues and commit again.

Questions?