Skip to content

Instantly share code, notes, and snippets.

@robertpainsi
Last active September 26, 2023 20:04
Star You must be signed in to star a gist
Embed
What would you like to do?
Commit message guidelines

Commit Message Guidelines

Short (72 chars or less) summary

More detailed explanatory text. Wrap it to 72 characters. The blank
line separating the summary from the body is critical (unless you omit
the body entirely).

Write your commit message in the imperative: "Fix bug" and not "Fixed
bug" or "Fixes bug." This convention matches up with commit messages
generated by commands like git merge and git revert.

Further paragraphs come after blank lines.

- Bullet points are okay, too.
- Typically a hyphen or asterisk is used for the bullet, followed by a
  single space. Use a hanging indent.

Example for a commit message

Add CPU arch filter scheduler support

In a mixed environment of…

A properly formed git commit subject line should always be able to complete the following sentence

If applied, this commit will <your subject line here>

Rules for a great git commit message style

  • Separate subject from body with a blank line
  • Do not end the subject line with a period
  • Capitalize the subject line and each paragraph
  • Use the imperative mood in the subject line
  • Wrap lines at 72 characters
  • Use the body to explain what and why you have done something. In most cases, you can leave out details about how a change has been made.

Information in commit messages

  • Describe why a change is being made.
  • How does it address the issue?
  • What effects does the patch have?
  • Do not assume the reviewer understands what the original problem was.
  • Do not assume the code is self-evident/self-documenting.
  • Read the commit message to see if it hints at improved code structure.
  • The first commit line is the most important.
  • Describe any limitations of the current code.
  • Do not include patch set-specific comments.

Details for each point and good commit message examples can be found on https://wiki.openstack.org/wiki/GitCommitMessages#Information_in_commit_messages

References in commit messages

If the commit refers to an issue, add this information to the commit message header or body. e.g. the GitHub web platform automatically converts issue ids (e.g. #123) to links referring to the related issue. For issues tracker like Jira there are plugins which also converts Jira tickets, e.g. Jirafy.

In header:

[#123] Refer to GitHub issue…
CAT-123 Refer to Jira ticket with project identifier CAT…

In body:

…
Fixes #123, #124

Sources

@svliantiss
Copy link

How do you do this all in the terminal, specifically referencing issues and other commits?

I'd wish there was a way to stage/pause your commit and use the GitHub interface to comment on it before finishing the push or pull request.

@sharozmirza
Copy link

Does GitHub support markdown in the commit messages?

@jesus2099
Copy link

jesus2099 commented Dec 31, 2019

  1. or reference them
Fetching an object is done by using the technique explained at [1] and…
…
[1] https://www.url.com/some/very/long/url/that/easily/exceeds/72/characters/per/line

We can use the more standard syntax below, so it can be interpreted more likely:

Fetching an object is done by using the technique explained at [cool page] and…
…

[cool page]: https://www.url.com/some/very/long/url/that/easily/exceeds/72/characters/per/line "optional tooltip"
[Official Markdown syntax for links]: https://daringfireball.net/projects/markdown/syntax#link "search reference-style in there"

Put all references in their own paragraph(s) and syntax is [refname]: url (with : a colon).

Result:

Fetching an object is done by using the technique explained at this cool page and…


Official Markdown syntax for links says Reference-style should be:

This is [an example][id] and [another example] [id] or even [id][] reference-style link.
…

[id]: http://example.com/  "Optional Title Here"

But it has been pretty common to just use [id] or [an example] instead of [id][] or [an example][] in the text paragraph.

@ronnielutalo
Copy link

Thank you very much for sharing this knowledge

@NSachida
Copy link

Thanks A Lot 🤗

@Ranjeetkumardev
Copy link

Ranjeetkumardev commented Oct 23, 2020

Can anyone help me plz. When I run a c++ code on vs code then in output section show access is denied . So what issue in my window 10 lp. Thanks a lot $many many whishess for u'r dream in advance

Mail me plz. Ranjeetrazz87654@gmail.com .becoz i'm new here

@NSachida
Copy link

Topics

  • C/C++ for Visual Studio Code

C/C++ support for Visual Studio Code is provided by a Microsoft C/C++ extension to enable cross-platform C and C++ development on Windows, Linux, and macOS.

Getting started

  • C/C++ compiler and debugger

The C/C++ extension does not include a C++ compiler or debugger. You will need to install these tools or use those already installed on your computer.

Popular C++ compilers are:

  • GCC on Linux
  • GCC via Mingw-w64 on Windows
  • Microsoft C++ compiler on Windows
  • Clang for XCode on macOS

"Make sure your compiler executable is in your platform path so the extension can find it." You can check availability of your C++ tools by opening the Integrated Terminal (⌃ (Windows, Linux Ctrl+)) in VS Code and try running the executable (for example g++ --help).
Install the Microsoft C/C++ extension#

Open VS Code.
Click the Extensions view icon on the Sidebar (⇧⌘X (Windows, Linux Ctrl+Shift+X)).
Search for c++.
Click Install.

Hello World tutorials


Get started with C++ and VS Code with Hello
World tutorials for your environment:

  • GCC on Windows
  • Microsoft C++ on Windows
  • GCC on Linux
  • GCC on Windows Subsystem For Linux
  • Clang/LLVM on macOS
Documentation

You can find more documentation on using the Microsoft C/C++ extension under the C++ section, where you'll find topics on:

Debugging
Editing
Settings
FAQ
Remote Development

VS Code and the C++ extension support Remote Development allowing you to work over SSH on a remote machine or VM, inside a Docker container, or in the Windows Subsystem for Linux (WSL).

To install support for Remote Development:

Install the VS Code Remote Development Extension Pack.
If the remote source files are hosted in WSL, use the Remote - WSL extension.
If you are connecting to a remote machine with SSH, use the Remote - SSH extension.
If the remote source files are hosted in a container (for example, Docker), use the Remote - Containers extension.

Feedback

If you run into any issues or have suggestions for the Microsoft C/C++ extension, please file issues and suggestions on GitHub. If you haven't already provided feedback, please take this quick survey to help shape this extension for your needs.

@asapconet
Copy link

Please I'd love to know if there are conventional name tags to give to headings?
For example; 'Fixes, Updates, Feature...'

@CalinZBaenen
Copy link

How do/should I format code in a Git commit message?
Everytime I try using backtick it removes the text (as it's not visible via git log and gone when I do git commit --amend).

Doing git commit --amend is no good, even when I edit the message outside the terminal the text still gets removed for some reason.

Since using backticks won't work, what should I use to format my code?

@CalinZBaenen
Copy link

@Ahmed654321653 What is that, now?

@slnc
Copy link

slnc commented Nov 14, 2022

What is the generally accepted practice if a commit contains numerous unrelated changes that cannot be described succinctly in just 50 characters?

Apply the "Single Responsability Principle" to the commit: split it into smaller logically self-contained commits whose contents can be explained in 50 chars.

I try to stick to that pattern but I sometimes take shortcuts when the cost or splitting is too high or the risk of changing several unrelated things at once is small.

@u-m-i
Copy link

u-m-i commented Aug 25, 2023

Minimalistic approach :

[Action] Short summary (50 chars or less, this is the subject)

(optional) #Issue

More detailed explanatory text, if necessary. Maximun 80 characters to
wrap it.

- Hypen for bullet points.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment