.. _scikit-plots-contributing:

.. Welcome to Scikit-plots 101 |br| |release| - |today|
..
    substitutions don’t work in .. raw:: html
    .. raw:: html

    <div style="text-align: center"><strong>
    Welcome to Scikit-plots 101<br>|full_version| - |today|
    </strong></div>
..
    https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-centered
    .. centered:: Welcome to Scikit-plots 101 :raw-html:`<br />` |full_version| - |today|
    .. centered::
        **Scikit-plots Documentation** :raw-html:`<br />` |full_version| - |today|

.. https://docutils.sourceforge.io/docs/ref/rst/directives.html#custom-interpreted-text-roles
.. role:: raw-html(raw)
   :format: html

.. |br| raw:: html

   <br/>

:raw-html:`<div style="text-align: center"><strong>` Scikit-plots Contributing
|br| |full_version| - |today|
:raw-html:`</strong></div>`

.. _developers-guide-index:

======================================================================
Contributing Guidelines to scikit-plots
======================================================================

.. docs/source/_sphinx_ext/skplt_ext/version_info_extension.py

.. ifconfig:: releaselevel != 'dev'

   .. important::

      If you plan to contribute to scikit-plots, please read the
      `development version <https://scikit-plots.github.io/dev/devel/index.html>`_
      of this document as it will have the most up to date installation
      instructions, workflow process, and contributing guidelines.

.. raw:: html

    <div style="text-align: center;">

:octicon:`heart;1em;sd-text-info`
Thank you for your interest in helping to improve scikit-plots!
:octicon:`heart;1em;sd-text-info`

.. raw:: html

    </div>

This project is a community effort, and everyone is welcome to contribute. Everyone
within the community is expected to abide by our :ref:`code of conduct <code_of_conduct>`.

There are various ways to contribute, such as optimizing and refactoring code,
detailing unclear documentation and writing new examples, helping the community,
reporting and fixing bugs, requesting and implementing new features...





.. Note:: Some Parts of this guides were adapted from the
    `matplotlib developer documentation <https://matplotlib.org/devdocs/devel/index.html>`__,
    `pandas developer documentation <https://pandas.pydata.org/pandas-docs/stable/development/index.html>`__,
    `astropy developer documentation <https://docs.astropy.org/en/latest/index_dev.html>`__,
    `scikit-learn developer documentation <https://scikit-learn.org/dev/developers/index.html>`__
    Scikit-plots is grateful to the these teams for their documentation efforts.


Quickstart Contribute Guide
================================

Here you'll find all the guidance and resources you need to quickly start contributing to this project.

.. CSS Classes: https://sphinx-design.readthedocs.io/en/latest/css_classes.html

.. grid:: 1 1 2 2
   :class-row: sf-fs-1
   :gutter: 2

   .. grid-item-card::
      :shadow: none

      **Quickstart Contributing**
      ^^^
      Get up and running quickly to local:

      .. toctree::
         :maxdepth: 2
         :caption: quickstart

         Quickstart Contribute Guide <guide_qu_contribute.rst>
         Contributing Code: A Worked Example <git_edit_workflow_examples.rst>

   .. grid-item-card::
      :shadow: none

      **Docker Desktop or Github Codespaces**
      ^^^
      Fast launch by `pre-installed` Docker Env:

      .. toctree::
         :maxdepth: 2
         :caption: docker

         Docker Guidelines <guide_docker.rst>


.. _submitting-a-bug-report:
.. _request-a-new-feature:

GitHub issue tracker
====================

The `issue tracker <https://github.com/scikit-plots/scikit-plots/issues>`_ serves as the
centralized location for making feature requests, reporting bugs, identifying major
projects to work on, and discussing priorities.

We have preloaded the issue creation page with markdown forms requesting the information
we need to triage issues and we welcome you to add any additional information or
context that may be necessary for resolving the issue:

.. CSS Classes: https://sphinx-design.readthedocs.io/en/latest/css_classes.html

.. grid:: 1 1 2 2

   .. grid-item-card::
      :class-header: sd-fs-5

      :octicon:`bug;1em;sd-text-info` **Submit a bug report**
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

      Thank you for your help in keeping bug reports targeted and descriptive.

      .. button-link:: https://github.com/scikit-plots/scikit-plots/issues/new/choose
            :expand:
            :color: primary

            Report a bug

   .. grid-item-card::
      :class-header: sd-fs-5

      :octicon:`light-bulb;1em;sd-text-info` **Request a new feature**
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

      Thank you for your help in keeping feature requests well defined and tightly scoped.

      .. button-link:: https://github.com/scikit-plots/scikit-plots/issues/new/choose
         :expand:
         :color: primary

         Request a feature

Since scikit-plots is an open source project with limited resources, we encourage users
to also :ref:`participate <contribute_code>` in fixing bugs and implementing new
features.


Getting Started Contribute Guide
=====================================

We welcome you to get more involved with the scikit-plots project! If you are new
to contributing, we recommend that you first read our
:ref:`Getting Started Contribute Guide <guide_gs_contribute>`:


.. toctree::
   :caption: getting started
   :hidden:

   Getting Started Contribute Guide <guide_gs_contribute.rst>

.. CSS Classes: https://sphinx-design.readthedocs.io/en/latest/css_classes.html

.. grid:: 1 1 2 2
   :class-row: sd-fs-5 sd-align-minor-center

   .. grid-item::

      .. grid:: 1
         :gutter: 1

         .. grid-item-card::
            :link: contribute_code
            :link-type: ref
            :class-card: sd-shadow-none
            :class-body: sd-text-{primary}

            :octicon:`code;1em;sd-text-info` Contribute code

         .. grid-item-card::
            :link: contribute_documentation
            :link-type: ref
            :class-card: sd-shadow-none
            :class-body: sd-text-{primary}

            :octicon:`note;1em;sd-text-info` Write documentation

         .. grid-item-card::
            :link: contribute_triage
            :link-type: ref
            :class-card: sd-shadow-none
            :class-body: sd-text-{primary}

            :octicon:`issue-opened;1em;sd-text-info` Triage issues

         .. grid-item-card::
            :link: other_ways_to_contribute
            :link-type: ref
            :class-card: sd-shadow-none
            :class-body: sd-text-{primary}

            :octicon:`globe;1em;sd-text-info` Build community

   .. grid-item::

      .. grid:: 1
         :gutter: 1

         .. grid-item::

            :octicon:`info;1em;sd-text-info` :ref:`Is this my first contribution? <new_contributors>`

         .. grid-item::

            :octicon:`question;1em;sd-text-info` :ref:`Where do I ask questions? <get_connected>`

         .. grid-item::

            :octicon:`git-pull-request;1em;sd-text-info` :ref:`How do I choose an issue? <managing_issues_prs>`

         .. grid-item::

            :octicon:`codespaces;1em;sd-text-info` :ref:`How do I start a pull request? <how-to-pull-request>`


.. _development_environment:

Development Workflow Guide
==========================

If you are contributing code or documentation, please follow our guide for setting up
and managing a development environment and workflow:

.. CSS Classes: https://sphinx-design.readthedocs.io/en/latest/css_classes.html

.. grid:: 1 1 2 2
   :class-row: sf-fs-1
   :gutter: 2

   .. grid-item-card::
      :shadow: none

      **Install Guide**
      ^^^
      .. toctree::
         :maxdepth: 2

         Development Setup Guide <guide_devel_setup.rst>


   .. grid-item-card::
      :shadow: none

      **Workflow Guide**
      ^^^^
      .. toctree::
         :maxdepth: 2

         Development Workflow Guide <guide_devel_workflow.rst>


   .. grid-item-card::
      :shadow: none

      **Troubleshooting Guide**
      ^^^^
      .. toctree::
         :maxdepth: 2

         Troubleshooting Guide <guide_troubleshooting.rst>


   .. grid-item-card::
      :shadow: none

      **Coding Guide**
      ^^^^
      .. toctree::
         :maxdepth: 2

         Coding Guide <guide_code.rst>


   .. grid-item-card::
      :shadow: none

      **C or Cython Extensions Guide**
      ^^^^
      .. toctree::
         :maxdepth: 2

         C or Cython Extensions Guide <guide_ccython.rst>


   .. grid-item-card::
      :shadow: none

      **Development Details Guide**
      ^^^^
      .. toctree::
         :maxdepth: 2

         Development Details Guide <guide_devel_details.rst>


.. _contribution_guideline:

Policies and Guidelines for Consistent Maintenance and Workflow Management
==========================================================================

These policies and guidelines help us maintain consistency in the various types
of maintenance work. If you are writing code or documentation, following these policies
helps maintainers more easily review your work. If you are helping triage, community
manage, or release manage, these guidelines describe how our current process works.

.. CSS Classes: https://sphinx-design.readthedocs.io/en/latest/css_classes.html

.. grid:: 1 1 2 2
   :class-row: sf-fs-1
   :gutter: 2

   .. grid-item-card::
      :shadow: none

      **Coding Guide**
      ^^^
      .. toctree::
         :maxdepth: 1

         guide_code_style_write
         guide_code_api_ver_change
         guide_code_testing
         Command-Line Scripts Guide <guide_cli_scripts.rst>

   .. grid-item-card::
      :shadow: none

      **Documentation Guide**
      ^^^
      .. toctree::
         :maxdepth: 1

         guide_document_write
         guide_document_style
         guide_document_tag

   .. grid-item-card::
      :shadow: none

      **Maintainer Guide**
      ^^^

      This section is about preparing a major/minor release, a release candidate (RC), or a bug-fix release.

      .. toctree::
         :maxdepth: 1

         guide_maintainer.rst
         conda-forge Guidelines <guide_maintainer_conda_forge.rst>

   .. grid-item-card::
      :shadow: none

      **Maintenance Guide**
      ^^^

      .. toctree::
         :maxdepth: 1

         guide_release
         guide_communication
         guide_min_dep_policy
         Sp Enhancement Proposals <SPEP/index.rst>

   .. grid-item-card::
      :shadow: none

      **Triage And Review Guide**
      ^^^
      .. toctree::
         :maxdepth: 1

         guide_triage
         guide_pr

   .. grid-item-card::
      :shadow: none

      **Git Resources Guide**
      ^^^
      .. toctree::
         :maxdepth: 1

         Git Resources Guide <guide_git_resources.rst>

.. CSS Classes: https://sphinx-design.readthedocs.io/en/latest/css_classes.html