Developer Guide#
There are many ways to contribute to the NeuroConv project! To help ensure a smooth Pull Request (PR) process, please always begin by raising an issue on the main repository so we can openly discuss any problems/additions before taking action.
The most common contribution is for a user/developer to help us integrate a new data format and shape it into a general data interface. A guideline on how to build a new data interface and a graphical overview of the object structure can be found here:
- Contributing
- Build a Data Interface
- Defining the form of source with schemas
- Metadata Schema
- Project Structure
- Testing Suite
- Coding Style
- Building the Documentation
- Manually Build Docker Images
- Publish Container to GitHub
- Run Docker container on local YAML conversion specification file
- Run Docker container on YAML conversion specification environment variable
- Making a Release
Or feel free to raise a bug report or feature request for our maintainers to prioritize!