.. _triqs_contributing:

Contributing
============

.. note::
   Do not open an issue on github if you have questions regarding the usage of the code
   which are specific to your problem. Consolidate the :ref:`documentation` and the
   :ref:`userguide` first. Should this not answer your questions, you can get in contact with
   other users and developers via our `Google group <https://triqs.github.io/announcements>`_.

Issues and feature requests
---------------------------

Please report bugs and feature request directly on the github
`issue page <https://github.com/TRIQS/triqs/issues>`_.  In order to make it easier
for us to treat your issue please use and fill one of the templates provided to you
when opening a `new issue <https://github.com/TRIQS/triqs/issues/new>`_.

Contributing to code and documentation
--------------------------------------

We are happy to receive your improvements and extensions to the code and documentation as
`pull requests <https://github.com/TRIQS/triqs/pulls>`_ on github.
Please coordinate the implementation of new features and major changes
directly with the TRIQS developers.

.. toctree::
   :maxdepth: 1

   contributing/pull_request
   contributing/documentation


Github discussions 
------------------

You can engage in discussions with other users and developers through the
`Github Discussions <https://github.com/TRIQS/triqs/discussions>`_ forum.
This channel is also used for the announcement of new releases and code updates.