pax_global_header00006660000000000000000000000064134374506430014523gustar00rootroot0000000000000052 comment=b9db3c8830dc7692026fb56a27bd41da425a4d4a fusiondirectory-1.3/000077500000000000000000000000001343745064300146165ustar00rootroot00000000000000fusiondirectory-1.3/.gitignore000066400000000000000000000000151343745064300166020ustar00rootroot00000000000000 .directory fusiondirectory-1.3/.gitlab-ci.yml000066400000000000000000000136221343745064300172560ustar00rootroot00000000000000# Specify docker image image: debian:stretch # Define variable to disable SSL verification of GIT variables: GIT_SSL_NO_VERIFY: "true" stages: - lint - codestyle - transifex - tarballs ## Stage lint # Perl lint create_perl_lint_rapport: stage: lint only: - branches before_script: - apt-get update -qq - apt-get install -y -qq libarchive-extract-perl libcrypt-cbc-perl libdigest-sha-perl libfile-copy-recursive-perl - apt-get install -y -qq libnet-ldap-perl libpath-class-perl libterm-readkey-perl libxml-twig-perl script: - perl -cW contrib/bin/fusiondirectory-setup contrib/bin/fusiondirectory-insert-schema # PHP lint (jessie) create_php_lint_rapport_jessie: image: php:5.6.33-cli-jessie stage: lint only: - branches script: - find . -type f -name '*.php' -o -name '*.inc' -print0 | xargs -0 -n1 php -l # PHP lint (stretch) create_php_lint_rapport_stretch: image: php:cli-stretch stage: lint only: - branches script: - find . -type f -name '*.php' -o -name '*.inc' -print0 | xargs -0 -n1 php -l # generate man pages to test validity create_manpages_lint_report: stage: lint only: - branches before_script: - apt-get update -qq - apt-get install -y -qq perl man-db script: - pod2man -c "FusionDirectory Documentation" -r "FusionDirectory 1.3" contrib/bin/fusiondirectory-insert-schema contrib/man/fusiondirectory-insert-schema.1 - pod2man -c "FusionDirectory Documentation" -r "FusionDirectory 1.3" contrib/bin/fusiondirectory-setup contrib/man/fusiondirectory-setup.1 - pod2man -c "FusionDirectory Documentation" -r "FusionDirectory 1.3" contrib/man/fusiondirectory.conf.pod contrib/man/fusiondirectory.conf.5 - lexgrog contrib/man/fusiondirectory-insert-schema.1 - lexgrog contrib/man/fusiondirectory-setup.1 - lexgrog contrib/man/fusiondirectory.conf.5 ## Stage codestyle # Generate perlcritic rapport create_perlcritic_rapport: stage: codestyle only: - branches before_script: - apt-get update -qq - apt-get install -y -qq libperl-critic-perl script: - cp contrib/bin/fusiondirectory-setup contrib/bin/fusiondirectory-setup.pl - cp contrib/bin/fusiondirectory-insert-schema contrib/bin/fusiondirectory-insert-schema.pl - perlcritic --quiet --verbose "%f~|~%s~|~%l~|~%c~|~%m~|~%e~|~%p~||~%n" contrib/bin # PHP codesniffer create_php_code_sniffer_rapport_13: stage: codestyle only: - branches before_script: - apt-get update -qq - apt-get install -y -qq git php-cli php-codesniffer script: - git clone https://gitlab.fusiondirectory.org/fusiondirectory/dev-tools.git -b 1.3 ../dev-tools - find . -type f -name '*.php' -o -name '*.inc' > ./filelist - phpcs --standard=../dev-tools/php-codesniffer-rules/FDStandard/ruleset.xml --file-list=./filelist # Sonar publishing sonar_publish: image: sonar-cli:3.1.0.1141 stage: codestyle only: - 1.3-dev script: - /home/sonar/*/bin/sonar-scanner -D sonar.projectKey=fusiondirectory-dev -D sonar.projectName=FusionDirectory-Dev -D sonar.projectVersion=1.3 -D sonar.sourceEncoding=UTF-8 -D sonar.exclusions='html/themes/legacy/**/*,include/class_xml.inc' -D sonar.gitlab.project_id="$CI_PROJECT_PATH" -D sonar.gitlab.commit_sha="$CI_COMMIT_SHA" -D sonar.gitlab.ref_name="$CI_COMMIT_REF_NAME" # Sonar preview sonar_preview: image: sonar-cli:3.1.0.1141 stage: codestyle except: - 1.3-dev script: - /home/sonar/*/bin/sonar-scanner -D sonar.projectKey=fusiondirectory-dev -D sonar.projectName=FusionDirectory-Dev -D sonar.projectVersion=1.3 -D sonar.sourceEncoding=UTF-8 -D sonar.exclusions='html/themes/legacy/**/*,include/class_xml.inc' -D sonar.gitlab.project_id="$CI_PROJECT_PATH" -D sonar.gitlab.commit_sha="$CI_COMMIT_SHA" -D sonar.gitlab.ref_name="$CI_COMMIT_REF_NAME" -D sonar.analysis.mode=preview # fusiondirectory-update-locale fusiondirectory-update-locale: image: php:cli-stretch stage: transifex only: - branches before_script: - apt-get update -qq - apt-get install -y -qq gettext git script: - git clone https://gitlab.fusiondirectory.org/fusiondirectory/dev-tools.git ../dev-tools - ../dev-tools/locale-scripts/fusiondirectory-update-locale -g # Update transifex update-transifex: image: php:cli-stretch stage: transifex only: - /^1.*$/ before_script: - apt-get update -qq - apt-get install -y -qq gettext git transifex-client script: - git clone https://gitlab.fusiondirectory.org/fusiondirectory/dev-tools.git ../dev-tools - echo $'[https://www.transifex.com]\nhostname = https://www.transifex.com\nusername = '"$TRANSIFEX_USER"$'\npassword = '"$TRANSIFEX_PASSWORD"$'\ntoken = '"$TRANSIFEX_API_TOKEN"$'\n' > ~/.transifexrc - tx pull -a -f - ../dev-tools/locale-scripts/fusiondirectory-update-locale -g - tx push -f -s -t --skip --no-interactive build-tarballs: stage: tarballs only: - /^1.*$/ script: - mkdir ../fusiondirectory-$(cut -d '-' -f1 <<< $CI_COMMIT_REF_NAME) - cp -a ./* ../fusiondirectory-$(cut -d '-' -f1 <<< $CI_COMMIT_REF_NAME) - mv ../fusiondirectory-$(cut -d '-' -f1 <<< $CI_COMMIT_REF_NAME) ./ artifacts: name: fusiondirectory-$(cut -d '-' -f1 <<< $CI_COMMIT_REF_NAME) paths: - ./fusiondirectory-$(cut -d '-' -f1 <<< $CI_COMMIT_REF_NAME) expire_in: 1h build-release: stage: tarballs only: - tags script: - mkdir "../fusiondirectory-$(grep '%' Changelog.md | head -n1 | cut -d ' ' -f3 | tr -d '"')" - cp -a ./* "../fusiondirectory-$(grep '%' Changelog.md | head -n1 | cut -d ' ' -f3 | tr -d '"')" - mv "../fusiondirectory-$(grep '%' Changelog.md | head -n1 | cut -d ' ' -f3 | tr -d '"')" ./ artifacts: name: fusiondirectory-"$(grep '%' Changelog.md | head -n1 | cut -d ' ' -f3 | tr -d '"')" paths: - ./fusiondirectory-"$(grep '%' Changelog.md | head -n1 | cut -d ' ' -f3 | tr -d '"')" fusiondirectory-1.3/.gitlab/000077500000000000000000000000001343745064300161365ustar00rootroot00000000000000fusiondirectory-1.3/.gitlab/.gitkeep000066400000000000000000000000001343745064300175550ustar00rootroot00000000000000fusiondirectory-1.3/.gitlab/issue_templates/000077500000000000000000000000001343745064300213445ustar00rootroot00000000000000fusiondirectory-1.3/.gitlab/issue_templates/.gitkeep000066400000000000000000000000001343745064300227630ustar00rootroot00000000000000fusiondirectory-1.3/.gitlab/issue_templates/Backporting.md000066400000000000000000000012361343745064300241330ustar00rootroot00000000000000### Description ### Source FusionDirectory Version ### Destination FusionDirectory Version ### Plugin with the new code ### Reason of Backporting code ### What defect does it correct ### Additional Information fusiondirectory-1.3/.gitlab/issue_templates/Bugs.md000066400000000000000000000014101343745064300225620ustar00rootroot00000000000000### Description ### Distribution Name and Version ### FusionDirectory Version ### PHP version used ### Origin of php packages ### Steps to Reproduce 1. [First Step] 2. [Second Step] 3. [and so on...] **Expected behavior:** **Actual behavior:** **Reproduces how often:** ### Additional Information fusiondirectory-1.3/.gitlab/issue_templates/Contribution.md000066400000000000000000000016441343745064300243520ustar00rootroot00000000000000### Requirements * Filling out the template is required. Any Enhancement request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion. * All new code requires tests to ensure against regressions ## Descriptive title for this contribution ### Step by step description of this contribution 1. [First Step] 2. [Second Step] 3. [and so on...] ### Schemas needed by this contribution ### Benefits ### Possible Drawbacks ### Actual use cases fusiondirectory-1.3/.gitlab/issue_templates/Enhancement.md000066400000000000000000000015311343745064300241130ustar00rootroot00000000000000### Requirements * Filling out the template is required. Any Enhancement request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion. * All new code requires tests to ensure against regressions ## Descriptive title for this enhancement ### Actual behavior ### Expected behavior ### Step by step description of new behaviour 1. [First Step] 2. [Second Step] 3. [and so on...] ### Benefits ### Possible Drawbacks ### Applicable Issues fusiondirectory-1.3/.gitlab/merge_request_templates/000077500000000000000000000000001343745064300230635ustar00rootroot00000000000000fusiondirectory-1.3/.gitlab/merge_request_templates/.gitkeep000066400000000000000000000000001343745064300245020ustar00rootroot00000000000000fusiondirectory-1.3/.gitlab/merge_request_templates/Merge.md000066400000000000000000000013071343745064300244450ustar00rootroot00000000000000### Requirements * Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion. * All new code requires tests to ensure against regressions ## Title of the Pull Requests ### Description of the Change ### Benefits ### Possible Drawbacks ### Applicable Issues fusiondirectory-1.3/.tx/000077500000000000000000000000001343745064300153275ustar00rootroot00000000000000fusiondirectory-1.3/.tx/config000066400000000000000000000002711343745064300165170ustar00rootroot00000000000000[main] host = https://www.transifex.com type = PO [FusionDirectory-13.core] file_filter = locale//fusiondirectory.po source_file = locale/en/fusiondirectory.po source_lang = en fusiondirectory-1.3/AUTHORS.md000066400000000000000000000147721343745064300163000ustar00rootroot00000000000000FusionDirectory AUTHORS ======================= This is the alphabetical list of all people that have contributed to the FusionDirectory project, beeing code, translations, documentation and additional help. * Markus Amersdorfer Wiki setup, Testing, hints, proposals * Alessandro Amici Italian translation * Holger Burbach Kerberos PHP module * Craig Chang Fixes for magic_quotes_qpc * Guillaume Delecourt Setup fixes, nagios tab plugin, xls addons ldapmanager pptp connectivity option, phpscheduleit connectivity option * Dan Ellis Sieve lib is taken from him * Alejandro Escanero Blanco Fixes, improvements, translation, netgroup plugin, Guide and some extensions * Fabian Hickert Improvements for setup, various fixes and plugins * Eric Kilfoil ldap.inc is taken from him * Niels Klomp Dutch translation * Steve Moitozo Password checker * Benoit Mortier Butracking, QA, French translation * Igor Muratov Various fixes and speed enhancements * Michael Pasdziernik Documentation for GOsa and safe-mode, fixes * Cajus Pollmeier Virtually everyting which is GOsa related * Piotr Rybicki Polish translation * Henning Schmiedehausen Various fixes, support for user defined people/group base * Alfred Schröder German translation * Thomas Schüßler debuglib.inc is taken from him * Jan Wenzel Implementation and research for samba munged dial support, fixing of "Fiptehlers"(TM) in the german translations. * Leila El Hitori French online documentation English online documentation * Vincent Seynhaeve Xls export plugin * Wouter Verhelst accept-to-gettext code that helps for language conversation * Antoine Gallavardin Add support for social network ORCID in personal Dhcp plugin patch to manage key and update zone in dhcp for dyndns First version of the quota plugin First version of the supann plugin First version of the board plugin * Leonid Bogdanov patch for the manager fonctionnality in the General user tab * Olivier BONHOMME Fedora and Centos Packager, selinux policy creator * Benjamin Carpentier Tested FusionDirectory, corrected copyright issues and locales Written fusiondirectory-setup * Giuliano Di Vito Italian Translator and bug finder * Roman Widmann Arch linux packager * Bernigaud Côme New daemon code class_supportDaemon.inc, and all the new deployment stuff :) Simple plugin framework developper * Alexis Michon Testing, First version of Password reset Support for two or more MAC address for a system * Mike Gabriel Various patches from debian-edu Apache 2.4 support Mcrypt decrypt enhancement Browsing inactive tab * Jeremy Williame Cleanup and writer of the FusionDirectory doxygen api documentation * Rudy Hardeman Option to remove sambaLMpassword storage * Gaston Tjebbes Feth Arezki First version of the autofs plugin * Daniel B Cleanup of the sambaPwdMustChange, sambaPwdCanChange * Regis patronix Allow special characters in passwords * Sergio Talens-Oliag Configuration setting to force the use of a hash when setting or changing passwords Add support for crypt/sha-256 and crypt/sha-512 Use the passwordDefaultHash for new users Fix for icons in core plugins Provide a way to show hook execution results to the user via web Hide userPassword on change_password postmodfy hook error message * Stefan Krüger Add support for various database to the rsyslog plugin * Guillaume Chéramy Patches for the template system * Mathias Friman mathias.friman@knorca.se Translation to swedish * Alexandre Magnat Snapshot bug reporter * Guillaume RODRIGUEZ asterisk plugin error reporter * Guillard Olivier SSH plugin key storage problem reporter * Fabien Brachere Fix support for special caracters in password * Arnaud Patard Fix for Invalid uri in the password recovery mail Fix for start tls on fusiondirectory setup and gnutls * Adrian Reyer Modifier for templates to convert german umlauts to 7-bit ASCII * Samuel Bosquin Plugin FAI - LVM partitions * IOhannes umlaeute generateLdif() fails with bind-passwords containg '$' patch * Karsten Becker Suse install from tarballs Documentation * Felix Weissbeck Method to add a change password dialog on sasl+kerberos * Tobias Göbel Fixes for PHP7 compatibility * Christian Kreidl ppolicy improvement * Martin Hamant Coded the LockUser fonction for the webservice * Jonathan Swaelens QA on FusionDirectory RPM packaging maintener and ArchLinux Packager * Timothée Giet New breezy icon Theme * Clement Oudot HTTP header authentication Password expiration date in dashboard * Thomas Niercke Code and ideas for making Argonaut Events Extensible * Paola Penati Italian translation of FusionDirectory and the website * Martin Hamant Adding DSA accounts into groups * Mathias Soupault Making supannAliasLogin usage possible in password recovery * Patzke Thomas  Security and vulnerabitity testing * Janne Heß Enhance the login and password reset theme * Peter Linss Added catchall table to postfix plugin * Renato Ramonda Support for SSH ed25519 keys fusiondirectory-1.3/CODE_OF_CONDUCT.md000066400000000000000000000062611343745064300174220ustar00rootroot00000000000000# Contributor Covenant Code of Conduct ## Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences * Gracefully accepting constructive criticism * Focusing on what is best for the community * Showing empathy towards other community members Examples of unacceptable behavior by participants include: * The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at . All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://www.contributor-covenant.org/version/1/4][version] [homepage]: https://www.contributor-covenant.org [version]: https://www.contributor-covenant.org/version/1/4/ fusiondirectory-1.3/CONTRIBUTING.md000066400000000000000000000236631343745064300170610ustar00rootroot00000000000000# Contributing to FusionDirectory projects ## Table Of Contents 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) * [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) 5. [Coding with style](#coding-with-style) * [Git Commit Messages](#git-commit-messages) * [PHP Style Guide](#php-style-guide) 6. [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.» :tada: 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](./CODE_OF_CONDUCT.md). 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! :+1: ### 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** [Coding style](https://fusiondirectory-developer-documentation.readthedocs.io/en/latest/coding/codingstandards.html) * **Use our** `PHP CodeSniffer `_ rules to check code compliance [CodeSniffer](https://fusiondirectory-developer-documentation.readthedocs.io/en/latest/coding/codingstandards.html#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](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 : * :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**: ``` ():