juliengdt

commit-msg - The Hook

Hooks are plugins which can be launch by git, on a special event. The commit-msg hook, if defined, is launched when user want commit

It's a git-enforced policy, used in entreprise to force dev to correctly format their commit messages

A custom one

Here is a custom commit-msg hook which looks for a format like these both:

• [ADD] - It's a message where i add something

juliengdt

Markdown Usage in Your Project

What it means ?

It means to use Markdown formatting and Markdown files to enhance your projects, more precisely the management around it.

Markdown synthax is essentially used for formatting raw text into a bit more sexy one (This file is MD formatted !).

juliengdt

NAME-OF-YOUR-PROJECT

This is a template README to show which informations it should contain.

You can talk about general purpose here in 2~3 lines to explain what it is.

Installation

Requirements

This is the requirement block; it explains which SW/HW you have to grab to run this project

juliengdt

CHANGELOG.md

1.8.0 (unreleased)

Features:

• add support for SVN sources -> 95f32s5b
• add metadata allowed_push_host to new gem template -> 95f32s5b
• adds a --no-install flag to bundle package -> 95f32s5b

juliengdt

Project Authors

This is where your explain when the project started, for which client, and list all devteams who contributes to it.

Project technical leads:

• John Foo - position - City (Country)
• Bar Doe - position - City (Country)