Merge branch '30-add-a-contribute-section' into '1.3'

Resolve "add a contribute section"

Closes #30

See merge request fusiondirectory/user-manual!159

(cherry picked from commit 55424823)

104ed297  feat(bugreport) add a section how to report a bug from user point of view

source/code-of-conduct.rst

+.. _code_conduct:
+
 Code of Conduct
 ===============
 

source/contribute/bugreport.rst

+Bug report
+==========
+
+#. `Welcome <#Welcome>`__
+#. `Code of Conduct <#code-of-conduct>`__
+#. `I just have a question! <#i-just-have-a-question>`__
+#. `How Can report a bug / feature missing ? <#how-can-i-contribute>`__
+
+   -  `Finding Wonderful Bugs <#finding-wonderful-bugs>`__
+   -  `Any Feedback To Enhance Our
+      Apps <#any-feedback-to-enhance-our-apps>`__
+
+--------------
+
+Welcome
+-------
+
+   «Here's a list of our guidelines, If you want to share a best
+   practice, or think one of these guidelines should be removed, feel
+   free to share it with us.»
+
+🎉 First off, thanks for taking the time to report bug and missing features !
+
+Now, sit comfortably at the fireplace, grab your glasses and immerse
+yourself in our documentation.
+
+Code Of Conduct
+---------------
+
+All projects and everyone participating in it is governed by
+FusionDirectory :ref:`code_conduct`
+
+By participating, you are expected to uphold this code. Please read this
+before.
+
+I just have a question!
+-----------------------
+
+.. note:: 
+   
+   Please don't file an issue to ask a question. You'll get
+   faster results by using the resource below.
+
+We have an various channel of communications
+
+-  `#fusiondirectory, the irc channel of FusionDirectory on
+   freenode <https://webchat.freenode.net/>`__, channel #fusiondirectory
+-  `FusionDirectory Users mailing
+   list <https://lists.fusiondirectory.org/wws/info/users>`__
+-  `FusionDirectory dev mailing
+   list <https://lists.fusiondirectory.org/wws/info/developpers>`__
+
+Reporting bug or missing features
+---------------------------------
+
+
+Register for a FusionDirectory project account
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To create a FusionDirectory project Account you must go to
+
+-  `FusionDirectory Sign UP <https://register.fusiondirectory.org>`__
+
+Put FusionDirectory in debug mode
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  Go into FusionDirectory configuration
+-  Activate the displaying of PHP errors, and the TRACE debug level
+
+Finding Wonderful Bugs
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. note::
+
+   This section guides you through submitting a bug report. Following
+   these guidelines helps maintainers and the community understand your
+   report, reproduce the behavior, and find related reports.
+
+When you are creating a bug report, please include as many details as
+possible. Fill out the **Bugs** template to create issues, the
+information it asks for helps us resolve issues faster.
+
+Explain the problem and include additional details to help maintainers
+reproduce the problem:
+
+-  **Use a clear and descriptive title** for the issue to identify the
+   problem.
+-  **Describe the exact steps which reproduce the problem** in as many
+   details as possible. For example, start by explaining wich brower and
+   it's version. When listing steps, don't just say what you did, but
+   explain how you did it. For example, if you moved the cursor to the
+   end of an input, explain if you used the mouse, or a keyboard.
+-  **Describe the behavior** you observed after following the steps and
+   point out what exactly is the problem with that behavior.
+-  **Explain which behavior** you expected to see instead and why.
+-  **Include screenshots and animated GIFs** which show you following
+   the described steps and clearly demonstrate the problem. You can use
+   `this tool <http://www.cockos.com/licecap/>`__ to record GIFs on
+   macOS and Windows, and `this tool <https://github.com/colinkeenan/silentcast>`__ on Linux.
+   
+-  **Include the PHP errors and trace** collected at the debug step
+   above
+-  **If the problem is linked to a specific LDAP entry** attach its LDAP
+   dump.
+
+Fill in a report on :
+
+-  `FusionDirectory <https://gitlab.fusiondirectory.org/fusiondirectory/fd/issues>`__
+   for the core program
+-  `FusionDirectory
+   Plugins <https://gitlab.fusiondirectory.org/fusiondirectory/fd-plugins/issues>`__
+   for plugins.
+
+Any Feedback To Enhance FusionDirectory
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. note::
+
+   This section guides you through submitting an enhancement suggestion,
+   including completely new features and minor improvements to existing
+   functionality. Following these guidelines helps maintainers and the
+   community understand your suggestion and find related suggestions.
+
+When you are creating a enhancement report, please include as many
+details as possible. Fill out the **Enhancement** template to create
+thoses issues, the information it asks for helps us resolve issues
+faster.
+
+-  `FusionDirectory <https://gitlab.fusiondirectory.org/fusiondirectory/fd/issues>`__
+   for the core program
+-  `FusionDirectory
+   Plugins <https://gitlab.fusiondirectory.org/fusiondirectory/fd-plugins/issues>`__
+   for plugins.
+
+-  **Use a clear and descriptive title** for the issue to identify the
+   suggestion.
+-  **Provide a step-by-step description of the suggested enhancement**
+   in as many details as possible.
+-  **Describe the current behavior** and **explain which behavior you
+   expected to see instead** and why.
+-  **Include screenshots and animated GIFs** which help you demonstrate
+   the steps which the suggestion is related to. You can use `this
+   tool <http://www.cockos.com/licecap/>`__ to record GIFs on macOS and
+   Windows, and `this
+   tool <https://github.com/colinkeenan/silentcast>`__ on Linux.
+-  **Explain why this enhancement would be useful** to most
+   FusionDirectory users.
+
+
+--------------
+
+This document is strongly inspired by the following resources:
+`ovh-ux-guidelines <https://github.com/ovh-ux/ovh-ux-guidelines>`__,
+`project-guidelines <https://github.com/wearehive/project-guidelines>`__,
+`Atom
+Guidelines <https://github.com/atom/atom/blob/master/CONTRIBUTING.md#reporting-bugs>`__,
+`Angularjs
+guidelines <https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md>`__.
+
+With love ❤️

source/contributing.rst

-Contribute
-==========
-
-There is a complete set of guidelines that you should read
-
-`Contributing to FusionDirectory <https://gitlab.fusiondirectory.org/fusiondirectory/fd/blob/1.3-dev/CONTRIBUTING.md>`_
-
-`Develop with FusionDirectory <https://fusiondirectory-developer-documentation.readthedocs.io/en/latest/>`_

source/index.rst

@@ -26,7 +26,7 @@ Contents:
    templates/index
    triggers/index
    faq/index.rst
-   contributing.rst
+   contribute/bugreport.rst
    support/index.rst
    security/index.rst
    license/index.rst