Skip to content

Latest commit

 

History

History
123 lines (84 loc) · 3.8 KB

CONTRIBUTING.adoc

File metadata and controls

123 lines (84 loc) · 3.8 KB
Raw

Contributing to the project

As a contributor, here are the guidelines we would like you to follow:

Commit Message Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history.

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 and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory .

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The header is mandatory, and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The footer should contain a closing reference to an issue if any. It could be replaced by the reference of your Jira ticket.

Samples:

docs(changelog): update changelog to beta.5
fix(release): need to depend on latest Gson library

The version of Gson library need to be updated in order to build the project.

Footer should contain a closing reference to an issue if any.

Revert

If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).

  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs).

  • docs: Documentation only changes.

  • feat: A new feature.

  • fix: A bug fix.

  • perf: A code change that improves performance.

  • refactor: A code change that neither fixes a bug nor adds a feature.

  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).

  • test: Adding missing tests or correcting existing tests.

  • chore: Others modifications that don’t modify src or test files.

  • revert: Reverts a previous commit.

Subject

The subject contains succinct description of the change

Body

The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

Important
 Please enable GitHooks in order to check your commit messages: 
   git config core.hooksPath .githooks

More information about conventional commits.

Tip
 Force using Linux EOF in your Windows machine repositories: 
	git config --global core.autocrlf false
	git config --global core.eol lf
	git rm --cached -rf .
	git diff --cached --name-only -z | xargs -n 50 -0 git add -f

WorkFlow

GitlabFlow

See GitlabFlow documentation.

Important
 Create a new pull request on Github (only if Github don’t find any conflict).

Code formatter

  1. Install Klint.

  2. Apply Ktlint settings:

   ktlint applyToIDEAProject