Skip to content

Latest commit

 

History

History
100 lines (64 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

100 lines (64 loc) · 2.17 KB

Contributing to the BIDS website

Welcome to the BIDS website repository!

We're so excited you're here and want to contribute.

We hope that these guidelines are designed to make it as easy as possible to get involved. If you have any questions that aren't discussed below, please let us know by opening an issue.

If you are not familiar with Git and GitHub, check our generic contributing guidelines.

If you want to contribute to the BIDS website, make sure you also read the instructions below.

Serving locally

Requirements

  • python >= 3.10
  • node.js >= ???
  • npm >= ???

Even though this is not required, having make installed will make it easier to easily serve the website locally.

Install and serve

Fork and clone the repository and its submodules

git clone https://github.com/YOUR_USER_NAME/bids-website.git --recurse-submodules

Create a virtual environment using conda, venv of what other environment management tool you prefer.

Install all the dependencies.

pip install -r requirements.txt

Generate all the content required for the build:

  • copies some pages from the specification repo

  • updates the list of contributors

  • generates the page for each BEP based on its metadata

  • updates the list of BIDS examples

  • generates all the 'plotly' interactive plots as html files in the tmp folder that will be 'injected' in the website as snippets (with --8<--)

make update

Serve the website with the mkdocs.

mkdocs serve

Maintenance

Requirements

Same as for the install but you will also need to install tox.

pip install tox

Update all files

make update

Run all formatting / linting tools

tox
make remark

Updating the requirements.txt

Update the appropriate line requirements.in and run:

python -m pip install pip-tools
pip-compile --strip-extras requirements.in