Giter VIP home page Giter VIP logo

commit-message-reference's Introduction

Commit Message Breakdown

This document serves as a reference for generating standardized and useful commit messages.

Commit Message Format

Type(Scope): Subject

Body (optional)

Footer (optional)

Example Commit Messages

Example 1

feat: Created new function for date / time conversion

Issue -> #987

Example 2

fix: Fixed 'null' return bug in 'lower_down' method

Type issue found in 'lower_down'. Added type.

Issue -> #275

Example 3

refactor: Cleaned up duplicate variable declarations  

Issue -> #98

Type

The type is a field that describes in one word what the commit will be addressing.

Common types

feat

  • A new feature

fix

  • A bug fix

docs

  • Changes in documentation

style

  • Style changes, formatting, missing semicolons or whitespace

refactor

  • Code changes that neither fixes a bug or adds a feature

perf

  • Changes that improve performance

test

  • Add missing tests

chore

  • Changes to the build process

Scope (optional)

The scope is an optional phrase describing parts of the code affected by the changes.

Subject

The subject contains a short description of the applied changes.

Body (optional)

The body is an optional space that is used to provide additional information or context.

Footer (optional)

The footer is an optional space that can be used to reference an open issue, or other item.

commit-message-reference's People

Contributors

kpvproctor avatar

Watchers

 avatar

commit-message-reference's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.