Ken Crandall OpenStackKen

Diagram Types

graph: creates a flowchart
sequence: creates a sequence diagram
gantt: creates a Gantt chart
class: creates a class diagram
pie: creates a pie chart

The following snippets show some common Markdown mistakes.

Click the Raw button to see the source text and understand the author's intent.

GitHub's parser handles some of these cases; other parsers do not.

To catch these problems automatically:

If .DS_Store was never added to your git repository, simply add it to your .gitignore file.

If you don't have one, create a file called

.gitignore

In your the root directory of your app and simply write

Quick examples

feat: new feature
fix(scope): bug in scope
feat!: breaking change / feat(scope)!: rework API
chore(deps): update dependencies

Commit types

build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci: Changes to CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
chore: Changes which doesn't change source code or tests e.g. changes to the build process, auxiliary tools, libraries

Conventional Commit Messages

See how a minor change to your commit message style can make a difference.

Tip

Have a look at git-conventional-commits , a CLI util to ensure these conventions, determine version and generate changelogs

Commit Message Formats

Default

Example: Moving up to a few commits to another branch

Branch A has commits (X,Y) that also need to be in Branch B. The cherry-pick operations should be done in the same chronological order that the commits appear in Branch A.

cherry-pick does support a range of commits, but if you have merge commits in that range, it gets really complicated

git checkout branch-B
git cherry-pick X
git cherry-pick Y

Name	Package Id	Version	Source
7Zip	7zip.7zip	19.0.0	winget
Alttab Salamander	salamander		choco
Alt-Tab Terminator	alt-tab-terminator		choco
AutoHotkey	Lexikos.AutoHotkey	1.1.33.02	winget
AutoHotkey Store Edition	HaukeGtze.AutoHotkeypoweredbyweatherlights.com	Latest	msstore (via winget)
Carnac

Add the following chunk to your existing ISC dhcpd.conf file.

if exists user-class and ( option user-class = "iPXE" ) {
    filename "http://boot.smidsrod.lan/boot.ipxe";
}
else {
    filename "undionly.kpxe";
}

(or see https://gist.github.com/4008017 for a more elaborate setup

	// create a doctype that includes definitions for all HTML entities - http://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
	var doctype = '<?xml version="1.0" standalone="no"?>' +
	'<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" [ '
	+ HTML_ENTITIES() + ' ]>';

	function HTML_ENTITIES() {
	return '<!ENTITY quot """> <!ENTITY amp "&"> <!ENTITY apos "'"> <!ENTITY lt "<"> <!ENTITY gt ">"> <!ENTITY nbsp " "> <!ENTITY iexcl "¡"> <!ENTITY cent "¢"> <!ENTITY pound "£"> <!ENTITY curren "¤"> <!ENTITY yen "¥"> <!ENTITY brvbar "¦"> <!ENTITY sect "§"> <!ENTITY uml "¨"> <!ENTITY copy "©"> <!ENTITY ordf "ª"> <!ENTITY laquo "«"> <!ENTITY not "¬"> <!ENTITY shy ""> <!ENTITY reg "®"> <!ENTITY macr "¯"> <!ENTITY deg "°"> <!ENTITY plusmn "±"> <!ENTITY sup2 "²"> <!ENTITY sup3 "³"> <!ENTITY acute "´"> <!ENT

	grep -rn '[[:blank:]]$' \
	--exclude=\*.svg \
	--exclude=\*.png \
	--exclude=\*.ico \
	--exclude=\*.graffle \
	--exclude=\*.jpg \
	docs/*