.. _contributing/how-to-contribute:

====================================
Getting Help and Ways to Contribute 
====================================


.. _contributing/index#shinken_resources_for_users:

Shinken resources for users (help) : 
=====================================


    * `Shinken documentation`_
    * :ref:`Shinken Troubleshooting FAQ <troubleshooting/troubleshooting-shinken>`
    * `Support Forums`_
    * `Shinken issues and bug reports`_
    * `Shinken Ideas`_


The documentation wiki contains a **Getting started** section for how-to and tutorial related information. It also hosts an official documentation that has the full in-depth details and a how to contribute section where you can learn how to help grow Shinken.

Your input and support is a precious resource. If the documentation is not clear, or you need help finding that nugget of information, the support forum has the answer to your burning questions. The Shinken Ideas page is a good place to let the development team how Shinken can improve to meet new challenges or better serve its user base.


Ways to contribute : 
=====================

    * help on the documentation `Shinken documentation`_
    * help on updating this web site
    * help on tracking and fixing bugs, `Shinken is on github`_ to make it easy!
    * coding new features, modules and test cases
    * performance profiling of the various daemons, interfaces and modules
    * providing references for large installations
    * submitting ideas to Shinken Ideas
    * responding to questions on the forums

.. tip::  Guidelines and resources are described for users in the first section and power users and developers in the second section.


Shinken Guidelines for developers and power users : 
====================================================

Guidelines that should be followed when contributing to the code

    * Guidelines - :ref:`Hacking the code <development/hackingcode>` [Examples of Shinken programming]
    * Guidelines - :ref:`How to add a new WebUI page <packages/webui/webui-devel>`
    * Guidelines - :ref:`Test driven development <development/test-driven-development>` [How to create and run tests]
    * Guidelines - :ref:`Programming rules <development/programming-rules>` [Style, technical debt, logging]
    * Informational - :ref:`Feature planning process and release cycle <about/features-and-release-cycle>`

Resources for developers and power users

    * Development - Collaborative code repository on `Shinken github`_
    * Development - Bug tracking on `Shinken github`_
    * Development - Automated test and integration on `Shinken Jenkins server`_
    * Development - The forums are also a good medium to discuss issues `Support Forums`_
    * Development - Developer Mailing list - `Register or search the shinken-devel Mailing list`_

For bug hunting and programming, you will need to look at the “How to hacking" tutorial page.

GitHub offers great facilities to fork, test, commit, review and comment anything related to Shinken. You can also follow the projects progress in real time.

There is a development mailing list where you can join us. Come and let us know what you think about Shinken, propose your help or ask for it. :)

Thank you for your help in making this software an open source success.

.. _Shinken issues and bug reports: https://github.com/naparuba/shinken/issues?sort=created&direction=desc&state=open
.. _Register or search the shinken-devel Mailing list: https://lists.sourceforge.net/lists/listinfo/shinken-devel
.. _Shinken github: https://github.com/naparuba/shinken/issues?sort=created&direction=desc&state=open
.. _Shinken Ideas: http://shinken.ideascale.com/
.. _Shinken documentation: http://shinken.readthedocs.org/
.. _Shinken Jenkins server: https://test.savoirfairelinux.com/view/Shinken/ 
.. _Shinken is on github: https://github.com/naparuba/shinken
.. _Support Forums: http://forum.shinken-monitoring.org/