Developer documentation
=======================

.. meta::

   :twitter:card: summary
   :twitter:site: @immuneml
   :twitter:title: immuneML dev docs
   :twitter:description: Browse developer docs for immuneML and see how to extend the platform with new components.
   :twitter:image: https://docs.immuneml.uio.no/_images/immuneML_packages.png


To get started with adding features to immuneML, follow the steps described here. These steps assume you have some experience with object-oriented programming in Python
and some basic knowledge of how Git works.

  #. Read the :ref:`Information for new developers` and other relevant tutorials as needed.
  #. Follow the guide to :ref:`Set up immuneML for development`.
  #. Create a new branch with a descriptive name from the master branch.
  #. Implement your changes and add documentation.
  #. Make a pull request to the master branch.

.. toctree::
  :maxdepth: 1
  :caption: Developer tutorials

  developer_docs/info_new_developers.rst
  developer_docs/install_for_development.rst
  developer_docs/how_to_add_new_encoding.rst
  developer_docs/how_to_add_new_ML_method.rst
  developer_docs/how_to_add_new_report.rst
  developer_docs/how_to_add_new_preprocessing.rst

.. toctree::
  :maxdepth: 1
  :caption: Platform overview

  developer_docs/data_model.rst
  developer_docs/execution_flow.rst

.. toctree::
  :maxdepth: 4
  :caption: List of all classes

  modules