Tags: development

Contribute

FieldTrip is an Open Source project with contributions from various individual users and research groups.

There are various ways in which you can contribute to FieldTrip.

Share your expertise

The FieldTrip community is organized around the email discussion list. You can contribute your expertise by helping other people, answering questions from other people on the email list, or post your ideas.

Report bugs or request enhancements

You can provide us with detailed bug reports. The easier it is for one of us to reproduce the bug, the more likely it is that we can fix the problem. You can use the same approach to request new functionality. We cannot guarantee that we have time to implement it, but it is good to know what people are trying to do or would like to do with FieldTrip.

The easier it is for one of the developers to reproduce your bug, the more likely it is that we’ll fix the problem. Good bug reports include a small test script and the data (i.e. mat file) required to reproduce the bug.

Contribute code

You can contribute by directly sharing your MATLAB code with us and help us integrate it into the FieldTrip toolbox. On the development section of this wiki you can find more details on how the development is organized. You can of course also ask.

When you contribute code, please consider the code guidelines to keep it consistent and compatible with the existing implementation. Also try to adhere to the existing representation of the data in the data structures.

Contribute documentation

You are invited to add your own tutorials, example scripts or answers to frequently asked questions to this website. Every time you type an email explaining something, please consider to add it here as well to increase the long term impact.

You can contribute directly to the documentation on this website by going to github, edit or add a page there and send your suggestion as a “pull request”. All contributions are reviewed by the maintainers. If you are not sure about the quality of your contribution, just submit it as pull request and we will check, improve and/or provide feedback if needed.

When adding documentation, please consider the documentation guidelines to keep it consistent with other documentation and to facilitate cross-linking.