Merge branch '30-guidelines-for-better-contributions' into '1.3'

Resolve "Guidelines for better contributions"

Closes #30

See merge request fusiondirectory/dev-manual!37

source/coding/codingstandards.rst

+.. _coding-style-label:
+
 Coding Style
 ============
 
@@ -277,6 +279,8 @@ Files Format
 
 * UTF-8, LF - not CR LF
 
+.. _checking-standard-label:
+
 Checking standards
 ------------------
 

source/contribute/guidelines.rst

 Guidelines for better contributions
 ===================================
 
-There is a complete set of guidelines that you should read
+Table Of Contents
+-----------------
 
-`Contributing to FusionDirectory <https://gitlab.fusiondirectory.org/fusiondirectory/fd/blob/1.3-dev/CONTRIBUTING.md>`_
+#. `Welcome <#Welcome>`__
+#. `Code of Conduct <#code-of-conduct>`__
+#. `I just have a question! <#i-just-have-a-question>`__
+#. `How Can I Contribute? <#how-can-i-contribute>`__
 
+   -  `Translate FusionDirectory in your
+      language <#translate-fusiondirectory>`__
+   -  `Finding Wonderful Bugs <#finding-wonderful-bugs>`__
+   -  `Any Feedback To Enhance Our
+      Apps <#any-feedback-to-enhance-our-apps>`__
+   -  `Your Awesome And Mighty Codes
+      Contributions <#your-awesome-and-mighty-codes-contributions>`__
 
+#. `Coding with style <#coding-with-style>`__
+
+   -  `Git Commit Messages <#git-commit-messages>`__
+   -  `PHP Style Guide <#php-style-guide>`__
+
+#. `Licensing <#licensing>`__
+
+--------------
+
+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 contribute !**
+
+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-of-conduct-label`.
+
+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>`__
+
+How Can I Contribute?
+---------------------
+
+So, you've developed a new cool feature? Fixed an annoying bug? Found a
+mistake? Want to help translate FusionDirectory in your own language.
+We'd be happy to hear from you!
+
+Translate FusionDirectory
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We are using
+`Transifex <https://www.transifex.com/fusiondirectory/FusionDirectory-1x/>`__
+to translate FusionDirectory.
+
+-  Create a transifex account
+-  Ask to be added to the language group you want to translate
+-  Start translating
+
+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
+~~~~~~~~~~~~~~~~~~~~~~
+
+   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 or `this
+   tool <https://github.com/GNOME/byzanz>`__ 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
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+   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>`__ or `this
+   tool <https://github.com/GNOME/byzanz>`__ on Linux.
+-  **Explain why this enhancement would be useful** to most
+   FusionDirectory users.
+
+Your awesome And Mighty Codes Contributions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+   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 contributing a new fonctionnality or plugin, please include
+as many details as possible.
+
+Fill out the **Contribution** 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 your
+   contribution
+-  **Provide a step-by-step description of the contribution** in as many
+   details as possible.
+-  **Include screenshots and animated GIFs** which help you demonstrate
+   what this contribution is about. 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>`__ or `this
+   tool <https://github.com/GNOME/byzanz>`__ on Linux.
+-  **Explain why this contribution would be useful** to most
+   FusionDirectory users.
+-  **Follow the** :ref:`coding-style-label`.
+-  **Use our**
+   `PHP CodeSniffer <http://pear.php.net/package/PHP_CodeSniffer>`_
+   rules to check code compliance :ref:`checking-standard-label`.
+
+Coding with style
+-----------------
+
+Git Commit Messages
+~~~~~~~~~~~~~~~~~~~
+
+   Having a good guideline for creating commits and sticking to it makes
+   working with Git and collaborating with others a lot easier.
+
+Here are some rules of thumb :
+
+-  Use the present tense ("Add feature" not "Added feature")
+-  If you have a body, separate the subject from the body with a newline
+-  Limit the subject line to 72 characters
+-  Do not end the subject line with a period
+-  Use imperative
+   `mood <https://en.wikipedia.org/wiki/Imperative_mood#English>`__ in
+   the subject line
+-  If the subject is not clear enough, use the body to explain what and
+   why as opposed to how
+-  Consider starting the commit message with an applicable emoji, when
+   you feel it's an important commit :
+
+.. code-block:: shell
+
+   :tada:      When first / initial commit
+   :sparkles:  When introducing new features
+   :ambulance: When fixing a bug
+   :handshake: When merging files
+   :tractor:   When you changing file structure or refactoring
+   :books:     When writing docs
+   :gem:       When new Release
+   :lipstick:  For cosmetics purposes
+
+Commit Message Format
+^^^^^^^^^^^^^^^^^^^^^
+
+Each commit message consists of a **header**, a **body** and a
+**footer**. The header has a special format that includes a **type**, a
+**scope** and a **subject**:
+
+::
+
+   <emoji> <type>(<scope>): <subject>
+   <BLANK LINE>
+   <body>
+   <BLANK LINE>
+   <footer>
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+Where type can be :
+
+* **feat**: A new feature
+* **fix**: A bug fix
+* **core**: Code for the Core
+* **docs**: Documenting the code or writing new documentation
+* **style**: Cosmetics purpose
+* **test**: Adding missing or correcting tests
+
+Examples:
+
+::
+
+   :sparkles: feat(supann): Make supannRefId multivaluated
+
+   supannRefId on Structure object is too small and mono valued
+
+   close #5685
+
+PHP style Guide
+~~~~~~~~~~~~~~~
+
+To be sure to respect our guidelines, read :ref:`coding-style-label`.
+
+Licensing
+---------
+
+For all new projects and most of older one we use **GPL2+ License**. You
+can find it here :ref:`license-label`.
+
+Make sure to use resources that we have the rights to use. Copyrighted
+images and videos may cause legal problems.
+
+--------------
+
+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 :heart:

source/license/license.rst

+.. _license-label:
+
 License
 =======