Merge branch '5705-correct-contributing-remove-part-about-using-the-templates-link' into '1.3-dev'

Resolve "Correct contributing remove part about using the templates link" Closes #5705 See merge request !30

Merge branch '5705-correct-contributing-remove-part-about-using-the-templates-link' into '1.3-dev'
Resolve "Correct contributing remove part about using the templates link" Closes #5705 See merge request !30
cfa93699 · bmortier · 99905828 · bfb5e12b · cfa93699
Commit cfa93699 authored 7 years ago by bmortier
Hide whitespace changes
Inline Side-by-side

Showing

with 39 additions and 45 deletions
+39 -45
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
 # Contributing to FusionDirectory projects
-:tada: First off, thanks for taking the time to contribute!
-> «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.»
 ## Table Of Contents
-1. [TL;DR](#tldr)
+1. [Welcome](#Welcome)
 2. [Code of Conduct](#code-of-conduct)
 3. [I just have a question!](#i-just-have-a-question)
 4. [How Can I Contribute?](#how-can-i-contribute)
@@ -19,38 +15,13 @@
 6. [Licensing](#licensing)
 ---
-## TL;DR
+## Welcome
-You're so excited to contribute that you do not have time to read the entire document. Here you will find some keys to quickly and safety contribute. :wink:
-1. [Our communication Channels](https://www.fusiondirectory.org/contact-us/). Feel free to discuss with us.
-2. Just be cool and respectful with others
-3. create an FusionDirectory project account at [FusionDirectory Sign UP](https://register.fusiondirectory.org)
-4. Use our `PHP CodeSniffer <http://pear.php.net/package/PHP_CodeSniffer>`_ rules to check code compliance [CodeSniffer](https://fusiondirectory-developer-documentation.readthedocs.io/en/latest/codingstandards.html#checking-standards)
-5. Your code should be tested
-6. Respect this simple commit message template
-```
-<emoji> <type>(<scope>): <subject>
-<BLANK LINE>
-<body>
-<BLANK LINE>
-<footer>
-```
-The **header** is mandatory and the **scope** of the header is optional.
+> «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.»
-Where type can be :
+:tada: First off, thanks for taking the time to contribute!
-  * **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
-7. For the subject, use the present tense ("Add feature" not "Added feature")
-8. Should be submitted through [FusionDirectory gitlab](https://gitlab.fusiondirectory.org) via a pull request on the 1.x-dev branch.
-Now, if you want to go further, sit comfortably at the fireplace, grab your glasses and immerse yourself in our documentation.
+Now, sit comfortably at the fireplace, grab your glasses and immerse yourself in our documentation.
 ## Code Of Conduct
@@ -85,7 +56,7 @@ To create a FusionDirectory project Account you must go to
 >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 required template, the information it asks for helps us resolve issues faster. We have a [template](Bugs.md) to create issues. Please use this template.
+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:
@@ -97,15 +68,21 @@ Explain the problem and include additional details to help maintainers reproduce
 * **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.
-Fill in [the template](Bugs.md), including the steps that you imagine you would take if the feature you're requesting existed.
-Enhancement suggestions are tracked on [FusionDirectory](https://gitlab.fusiondirectory.org/fusiondirectory/fd/issues) for the core program, and 
-[FusionDirectory Plugins](https://gitlab.fusiondirectory.org/fusiondirectory/fd-plugins/issues) for plugins.
-After you've determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the following information:
+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.
@@ -114,13 +91,22 @@ After you've determined which repository your enhancement suggestion is related
 * **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.
-* Fill in [the required template](Merge.md)
+When you are contributing a new fonctionnality or plugin, please include as many details as possible.
-* Include screenshots and animated GIFs in your pull request whenever possible.
-* Follow the [Coding standards](https://fusiondirectory-developer-documentation.readthedocs.io/en/latest/codingstandards.html#coding-standards)
+Fill out the **Contribution** template to create thoses issues, the information it asks for helps us resolve issues faster.
-* Use our `PHP CodeSniffer <http://pear.php.net/package/PHP_CodeSniffer>`_ rules to check code compliance [CodeSniffer](https://fusiondirectory-developer-documentation.readthedocs.io/en/latest/codingstandards.html#checking-standards)
-* End all files with a newline
+* [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** [Coding style](https://fusiondirectory-developer-documentation.readthedocs.io/en/latest/coding/codingstandards.html)
+* **Use our** `PHP CodeSniffer <http://pear.php.net/package/PHP_CodeSniffer>`_ rules to check code compliance [CodeSniffer](https://fusiondirectory-developer-documentation.readthedocs.io/en/latest/coding/codingstandards.html#checking-standards)
 ## Coding with style
@@ -159,6 +145,14 @@ Each commit message consists of a **header**, a **body** and a **footer**.  The
 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:
 ```
@@ -171,7 +165,7 @@ close #5685
 ### PHP style Guide
-To be sure to respect our guidelines, read [Coding standards](https://fusiondirectory-developer-documentation.readthedocs.io/en/latest/codingstandards.html#coding-standards)
+To be sure to respect our guidelines, read [Coding standards](https://fusiondirectory-developer-documentation.readthedocs.io/en/latest/coding/index.html)
 ## Licensing