.. _developer_guide:

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 <https://github.com/catalystneuro/neuroconv/issues>`_ 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:

.. toctree::
    :maxdepth: 1

    Contributing <contributing>
    Build a Data Interface <build_data_interface>
    Metadata Principles <metadata_principles>
    Timing Model <timing_model>
    Ophys Metadata Structure <ophys_metadata_structure>
    Fiber Photometry Metadata Structure <fiber_photometry_metadata_structure>
    Events Metadata Structure <events_metadata_structure>
    Pose Estimation Metadata Structure <pose_metadata_structure>
    Schemas <schemas>
    Provenance Record <provenance>
    Project Structure <project_structure>
    Testing Suite <testing_suite>
    Coding Style <style_guide>
    Deprecations <deprecations>
    Building the Documentation <building_documentation>
    Building the Docker Image <docker_images>
    Making a Release <making_a_release>

Or feel free to raise a `bug report <https://github.com/catalystneuro/neuroconv/issues/new?assignees=&labels=bug&template=bug_report.yml&title=%5BBug%5D%3A+>`_ or `feature request <https://github.com/catalystneuro/neuroconv/issues/new?assignees=&labels=enhancement&template=feature_request.yml&title=%5BFeature%5D%3A+>`_ for our maintainers to prioritize!