Guidelines for better contributions


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 Code of 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

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 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

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 to record GIFs on macOS and Windows, and this tool or this tool 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 :

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 for the core program
  • FusionDirectory Plugins 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 to record GIFs on macOS and Windows, and this tool or this tool 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 for the core program
  • FusionDirectory Plugins 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 to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this contribution would be useful to most FusionDirectory users.
  • Follow the Coding Style.
  • Use our PHP CodeSniffer rules to check code compliance Checking standards.

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 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 :
: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 Coding Style.

Licensing

For all new projects and most of older one we use GPL2+ License. You can find it here License.

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, project-guidelines, Atom Guidelines, Angularjs guidelines.

With love :heart: