Contributing

Contributing#

🐣 We’re so excited you’re here and want to contribute. 🐣

The point of this starter kit is to welcome new users and contributors to the BIDS community. 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 through one of the many ways to get in touch.

Writing in markdown#

GitHub has a helpful page on getting started with writing and formatting on GitHub.

Most of the writing that you’ll do will be in Markdown. You can think of Markdown as a few little symbols around your text that will allow GitHub to render the text with a little bit of formatting. For example you could write words as bold (**bold**), or in italics (*italics*), or as a link ([link](https://https://youtu.be/dQw4w9WgXcQ)) to another webpage.

Matlab / Octave#

We are using the Miss_hit linter to help us keep out matlab “clean”. You can find more information on how to set it up and use it on the bids-matlab contributing guidelines.

Templates#

This repository is under development, but we aim to have two templates for each BIDS sidecar file:

  • one with a full example (all required/recommended/optional fields),

  • one with a short example (only required fields).

If possible try to provide a script (python, octave, matlab) to generate those templates.

Try to name your script as follow: createBIDS_<suffix>_<extension>_*.[py|m]

createBIDS_T1w_json_short.m

To contribute a template you’ll need to submit a pull request.


Contents