Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.87 KB
Raw

Contributing to Brainstorm-Users

Thank you for sharing with Brainstorm!

This repository gathers data, processes and scripts shared by Brainstorm users.
If you are looking for Brainstorm source code, check this other repo.

Contributions to this repository include:

Folder Description
data Data description
processes Custom processes based on the Brainstorm process structure
scripts Matlab scripts to handle, processing or simulate data.

To know other ways in which you can collaborate with Brainstorm, visit the Contribute page.

How to share your codes

We use the GitHub Flow as guideline for contributions.
The general process to contribute to Brainstorm consists of 7 steps:

  1. Create your copy of the official Brainstorm repo
  2. Link your local repo to the official Brainstorm repo
  3. Create a branch in your local repo
  4. Work on the desired changes
  5. Done with the changes
  6. Create a new Pull Request allowing edits by maintainers.
  7. Code review

Detailed information for each step and resources to Git and GitHub can be found in the CONTRIBUTING file for the Brainstorm repo.

❓ Do not hesitate in contacting us if you have any question.