:orphan:

=============================
MPAS-A Code Contributor Guide
=============================

This document is intended to describe general development practices within the MPAS project. The information contained should be read prior to starting a project within the MPAS framework. Instructions can be used by MPAS core developers, or external developers. Notes specific to external developers are made where relevant.

|

.. container:: row m-0 p-0
            
   .. container:: col-md-12 pl-0 pr-3 py-3 m-0
   
      .. container:: card px-0 h-100
      
         .. rst-class:: card-header h4
         
            .. rubric:: `Becoming an MPAS Developer <https://www2.mmm.ucar.edu/projects/mpas/site/documentation/contributor_guide/becoming_developer.html>`__ 
            
         .. container:: card-body

            A summary on becoming an MPAS developer 
         
   .. container:: col-md-12 pl-0 pr-3 py-3 m-0

      .. container:: card px-0 h-100

         .. rst-class:: card-header h4 
      
            .. rubric:: `Repository Descriptions <https://www2.mmm.ucar.edu/projects/mpas/site/documentation/contributor_guide/repo_descriptions.html>`__
      
         .. container:: card-body
      
            Descriptions of MPAS development/release, testing, documents, tools, and data

   .. container:: col-md-12 pl-0 pr-3 py-3 m-0

      .. container:: card px-0 h-100

         .. rst-class:: card-header h4 
      
            .. rubric:: `Development <https://www2.mmm.ucar.edu/projects/mpas/site/documentation/contributor_guide/development.html>`__
      
         .. container:: card-body
      
            An overview of the code development process, including designing documents, forks, pull requests, branch strategy, release branches, and version numbers

   .. container:: col-md-12 pl-0 pr-3 py-3 m-0

      .. container:: card px-0 h-100

         .. rst-class:: card-header h4 
      
            .. rubric:: `Development Guidelines <https://www2.mmm.ucar.edu/projects/mpas/site/documentation/contributor_guide/dev_guidelines.html>`__
      
         .. container:: card-body
      
            Development guidelines for code contributors, including general code introduction and parallelization strategy

   .. container:: col-md-12 pl-0 pr-3 py-3 m-0

      .. container:: card px-0 h-100

         .. rst-class:: card-header h4 
      
            .. rubric:: `Addition of a New Core <https://www2.mmm.ucar.edu/projects/mpas/site/documentation/contributor_guide/new_core.html>`__
      
         .. container:: card-body
      
            Information about adding a new core

   .. container:: col-md-12 pl-0 pr-3 py-3 m-0

      .. container:: card px-0 h-100

         .. rst-class:: card-header h4 
      
            .. rubric:: `Copyright Information <https://www2.mmm.ucar.edu/projects/mpas/site/documentation/contributor_guide/copyright.html>`__
      
         .. container:: card-body
      
            Copyright information

   .. container:: col-md-12 pl-0 pr-3 py-3 m-0

      .. container:: card px-0 h-100

         .. rst-class:: card-header h4 
      
            .. rubric:: `Core Maintainers <https://www2.mmm.ucar.edu/projects/mpas/site/documentation/contributor_guide/maintainers.html>`__
      
         .. container:: card-body
      
            A list of maintainers for each core

 



   .. toctree::
      :maxdepth: 3
      :hidden:

      Becoming a Developer <contributor_guide/becoming_developer.rst>
      contributor_guide/repo_descriptions.rst
      contributor_guide/development.rst
      contributor_guide/dev_guidelines.rst
      contributor_guide/new_core.rst
      contributor_guide/copyright.rst
      contributor_guide/maintainers.rst