Contributing

We welcome contributions to the LAION-fMRI documentation and tooling.

Ways to Contribute

• Improve documentation - fix typos, add examples, clarify explanations

• Report issues - found something unclear or incorrect? Open a GitHub issue

• Share analysis examples - scripts, notebooks, or visualizations that might help other researchers

Setting Up

1. Fork and clone the repository:

   git clone https://github.com/YOUR-USERNAME/LAION-fMRI.git
   cd LAION-fMRI
   

2. Create the development environment:

   conda env create -f environment.yml
   conda activate laion-fmri-dev
   

3. Build the docs:

   cd docs
   make html
   # Open docs/build/html/index.html in your browser
   

Making Changes

1. Create a branch: git checkout -b your-branch-name

2. Edit files in docs/source/ (reStructuredText format)

3. Build and preview: make html

4. Commit, push, and open a Pull Request on GitHub

Style Guide

• Write for cognitive neuroscientists, not engineers: avoid jargon unless it’s the precise term, and prefer plain language over marketing register

• Include runnable code examples where they replace prose

• Match the existing reStructuredText structure and cross-reference conventions

Questions?

Open an issue on GitHub.