All people are very much welcome to contribute to code, documentation, testing and suggestions.
- Check this page to see how to make a commit.
- You don't know how much about code? You can contribute to documentation by creating tutorials, help and info!
- The master branch is protected: you should first start to create a new branch in your git clone, called for example "bugfix-readdata" or "feature-readeeg". Then, you add your commits to this branch, push it and create a pull request to merge it to master. In other words, avoid modifications from master to master.
- NeuroKit is currently organized into 5 major sections: Biosignals, M/EEG, statistics, miscellaneous and implementation of several statistical procedures used in psychology/neuroscience. However, this structure might be changed in order to be clarified or expanded (MRI processing, eye tracking, ...).
- API coherence has to be maintained/increased, with functions starting with the same prefix (
find_,read_,compute_,plot_,ecg_, etc.) so that the user can easily find them by typing the "intuitive" prefix.
- Authors of code contribution will be added within the contributor section within the documentation.
- Authors of code contribution are invited to follow the PEP 8 style sheet to write some nice (and readable) python.
- Contrary to Python recommandations, I prefer some nicely nested loops, rather than a one-liner ["that" for s if h in i for t in range("don't") if "understand" is False].
- Please document and comment your code, so that the purpose of each step (or code line) is stated in a clear and understandable way.
- Avoid unnecessary function splitting into smaller bits: it makes testing and reading of the code more difficult (as one must jump between functions and files to understand what's happening).
- Avoid unnecessary use of "magic" functions (preceded by underscores,
_foo()). I don't know I don't find them elegant. But it's personal. I might be wrong.