Skip to content

Latest commit

 

History

History
44 lines (25 loc) · 2.78 KB

contributing.md

File metadata and controls

44 lines (25 loc) · 2.78 KB
Raw

Contributing to LIMO EEG

Thank you considering contributing to the project.

This guideline is designed to make clear how anyone can contibute, become team member, and get rewarded for it. If you have any questions please get in touch.

Table of contents

Joining the project

LIMO EEG is open source and open developpment project focusing on the LInear Modeling of EEG data. As such it is required that all contributions adhere to our Code of Conduct.

How do you know that you joined? well, you're here and you likely used limo_eeg and started doing something beyond just using and want to push, add you bug fixes / code / documentation / exemples .. ot have your own extension - Welcome! you are now part of the project.

Contributing without writing a line of code

There are many ways you can contribute to the project without having to wite a single line of code!

  • editing and updating the wiki all the /help/docs should really be updated and moved over.
  • making any tutorials, exemples available

Contributing through code

Obviously, there is plenty of work to do :-)

We are happy to have contributors fixing and improving the code (functionalization is awesome and needed btw). If you plan to do this a lot, ask to become a contributor to have access writes and you'll be able to either work on the develop branch or if you prefer have your own branch, you can use pull request.

You like limo_eeg and want to understand better various bits and wrote some code to understand basic function behaviour. It looks like you have been running a unit test! let us know so we can incordporate it.

Plug you own linear tools! let's say you have some cool analyses that run at the subject level and now you want to do stats. LIMO EEG 2nd level analyses tools can help and easy to interface with - we can do as you want: write wrappers from your tool to LIMO EEG, incorporate your tool in the distribution directly, incorporate your tool as external, etc.

Recognizing contributions

We welcome and recognize all contributions from documentation to testing to code development. Contributors are listed here and when possible, we'd like to associate you to future publication.

Thank you!

You're awesome.