=========================
Contributing to ``rgpot``
=========================


We welcome all contributions and contributors to ``rgpot``. Whether you
report bugs, improve documentation, or submit code, your help makes the tools
better for everyone.

Communication and Conduct
-------------------------

We value a respectful and inclusive community. All contributors must follow our
`Code of Conduct <https://rgpycrumbs.rgoswami.me/code_of_conduct.html>`_.

Getting Started
---------------

Please review the technical requirements before submitting a Pull Request:

Development Environment
    We use ``pixi`` for environment management.
    See the `Developer Guide <developer/index.rst>`_ for setup and common tasks.

Documentation
    We author all documentation in ``orgmode`` converted to ``rst``.
    See `Developer FAQ <developer/faq.rst>`_ for documentation workflow details.

Reporting Issues
----------------

Use the `GitHub issue tracker <https://github.com/HaoZeke/rgpycrumbs/issues>`_ to report bugs or suggest enhancements. Please
provide a minimal reproducible example for all bug reports. User facing comments
may be directed also to the `EON materials science section <https://matsci.org/c/eon/72>`_.

Contributing
------------

For details on the dispatcher architecture or internal API:

  .. toctree::
     :maxdepth: 2
     :caption: Reference

     developer/index
     ../code_of_conduct