Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 2.88 KB

git.md

File metadata and controls

93 lines (63 loc) · 2.88 KB

Git

Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.

Configuration

Set user name and email for signed message:

git config --global user.name "John Doe"               # set username for all git projects
git config --global user.email [email protected]     # set email for all git projects

Main Commands

Basic commands:

git clone <repository>   # get a local copy of a git project
git commit -s -a         # commit all changes with a signature
git pull                 # get all changes from a remote repository
git push                 # push all change to a remote repository
git log                  # show commit logs

Git Commit 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. But also, we use the git commit messages to generate the AngularJS change log.

The commit message formatting can be added using a typical git workflow.

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>

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.

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 should correspond to a category such as for Invenio:

  • theme
  • dojson
  • search
  • etc.

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.

References

  1. main site