.. _PageNavigation contributing_index:

Project Contribution
####################


The Znuny project is sponsored by `Znuny GmbH <https://znuny.com>`_. Partners of the `OTTER Alliance <https://www.otter-alliance.de/die-allianz>`_ also contribute regularly to the code-base. While many in our community may not need or want commercial support, which largely contributes to funding the project, they may want to contribute code. The community happily looks forward to every pull request, and we want to ensure you have all guidelines necessary to get your contributions quickly merged. Your hard work is invaluable for the project, and therefore we have worked hard to be clear about the submission process and requirements.

The easiest way to send your contributions to the project's developer team is by creating a "pull request" in GitHub. Please take a look at the instructions on `GitHub Support <https://docs.github.com/en>`_, specifically about `Pull requests <https://docs.github.com/en/pull-requests>`_. and `Forking a repository <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_

Contributions are heartily welcome. Please carefully read: :ref:`guidelines for developers <Contributions DeveloperGuidelines>` and commit before you commit!

The basics contributor workflow for new developers:

1. Fork on GitHub (if brand new)
2. Clone your repository locally
3. Create a new branch
4. Develop, Test, Commit, Repeat
5. Push your changes to your repository
6. Create a pull request

Developer Guidelines
*********************
:ref:`- jump top - <PageNavigation contributing_index>`

.. _Contributions DeveloperGuidelines:

Follow our simple guidelines to ensure smooth integration by our developers.


* Create tests for your code.
* Create documentation for your coed.
* Run the code policy on your code.

Guideline Listing
*****************
:ref:`- jump top - <PageNavigation contributing_index>`

.. toctree::
   :maxdepth: 2

   coding_standards/accessibility
   coding_standards/code-style-guide
   coding_standards/ui-design
   how-to-extend-otrs
   translate

Additional Resources
####################
:ref:`- jump top - <PageNavigation contributing_index>`

* `Commercial Services <https://znuny.com>`_
   Here you can also find information about professional services and training seminars from the project maintainers.
* `Online API Library <https://doc.znuny.org/legacy/api/otrs/6.0/Perl/>`_
* `Discord Developer Discussion <https://discord.gg/ajaFnUqP>`_