Skip to content

Latest commit

 

History

History
151 lines (103 loc) · 4.48 KB

CODING.md

File metadata and controls

151 lines (103 loc) · 4.48 KB
Raw

Developer Contribution

Installing

Getting the code:

git clone https://github.com/Badisi/xkeybrew.git

Installing the dependencies:

# Global dependencies
npm install -g gulp electron-prebuilt

# Local dependencies
npm install
bower install

Testing

From the project's root directory:

# Start a web server
gulp serve

# Launch the application
gulp electron

Building

From the project's root directory:

gulp build

Coding Rules

To ensure consistency throughout the source code, get inspired by the following rules:

and keep them in mind as you are working!

Git Commit Guidelines

Like the Angular Team we are using 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 but also helps to generate the XKeyBrew Changelog document.

A detailed explanation of Angular Team's guidelines and conventions can be found in this document.

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:

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

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

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:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
Scope

The scope could be anything specifying place of the commit change.

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end
Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

This information is optional

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 are intended to highlight (in the Changelog) changes that will require community users to modify their code with this commit.


Sample Commit message:
refactor(content): prefix mdContent scroll- attributes

    BREAKING CHANGE: md-content's `scroll-` attributes are now prefixed with `md-`.

    Change your code from this:

    ```html
    <md-content scroll-x scroll-y scroll-xy>
    ```

    To this:

    ```html
    <md-content md-scroll-x md-scroll-y md-scroll-xy>
    ```