Skip to content

How to contribute

Join our working group at the International Neuroinformatics Coordinating Facility

There are many ways in which you can contribute to this project.

We have a list of milestones for the different features we would like to include in this project.

Those milestones have several opened issues related to them: have a look through those issues to see if there is any of them where you think you can help.

We are also track the progress to our different goals using some of the integrated kanban boards that github offers.

Kanban boards:

They are a great way to keep track of who is doing what, how the different tasks of your project are moving along...

Suggestions

If you are unsure where to start, maybe have a read through some of those sections about the project. It might give you ideas.

Otherwise here are some suggestions of the different tasks that you can contribute to. If however you feel more interested to start hacking at some of the issues related to long other goals, feel free to do so.

Spreadsheets

A lot of the work requires to interact with the checklists in their spreadsheet format.

The spreadsheets are hosted on this google drive folder and we try to keep a back-up in the csv folder.

The MRI part is the more advanced at this moment but we are looking for people to help with the M/EEG part.

The content of the spreadsheets and the work involved there is described in more details here.

Boilerplate method sections

We want to create boilerplate method sections corresponding to a single item or a set of items of the checklist to automate methods writing once the checklist is completed. There is a lot of work to do there in terms of writing the boilerplate text as well as automating the methods section generation.

Boilerplate related issues listed here.

Documentation

If you don't understand something about the project, its goals, its implementation or how to use, then it's most likely that we did not do a good enough job at explaining and describing it. Get in touch and we can work together to improve our documentation.

There are also several aspects of the documentation that need to be expanded.

Conversion scripts

We use some python code to convert the spreadsheets into the set of jsonld files that the user interface needs as inputs to display the checklists. This needs further improvement so if python is your jam, feel free to dive in.

We are also using the Reproschema python package to validate the schemas created. This package should also in the long-term help automating the creation of schemas, so there are definitely some features waiting to be written there.

There is more information on how to set things up in the CONTRIBUTING.md and the readme of the python package.

User interface

The user interface is Javascript based and uses the Vue framework and this also needs a lot of tweaking, so if Javascript is cup of tea: get in touch!

Here are some of the issues related to the UI.

Style guide

Python

We rely on black to automate the python code formatting.

We have additional checks on Github for code style and quality.

  • pep8 speaks for code style

  • the awesome sourcery for code quality and refactoring suggestions.

Markdown