\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{finuex} \pdfinfo{ /Title (conventional-commits-1-0.pdf) /Creator (Cheatography) /Author (finuex) /Subject (Conventional Commits 1.0 Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{7AA344} \definecolor{LightBackground}{HTML}{F6F9F3} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Conventional Commits 1.0 Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{finuex} via \textcolor{DarkBackground}{\uline{cheatography.com/198426/cs/43837/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}finuex \\ \uline{cheatography.com/finuex} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 13th July, 2024.\\ Updated 13th July, 2024.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{tabularx}{17.67cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{17.67cm}}{\bf\textcolor{white}{Description}} \tn \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{A specification for adding human and machine readable meaning to commit messages from \{\{link="https://www.conventionalcommits.org/en/v1.0.0"\}\}Conventional Commits\{\{/link\}\}% Row Count 4 (+ 4) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{17.67cm}}{\bf\textcolor{white}{Commit message structure}} \tn \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{\textless{}type\textgreater{}{[}optional scope{]}: \textless{}description\textgreater{} \newline % Row Count 1 (+ 1) {[}optional body{]} \newline % Row Count 2 (+ 1) {[}optional footer{]}% Row Count 3 (+ 1) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{A commit that has the text {\bf{BREAKING CHANGE}}: at the beginning of its optional body or footer section introduces a breaking API change} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{x{3.5427 cm} x{9.1098 cm} x{4.2175 cm} } \SetRowColor{DarkBackground} \mymulticolumn{3}{x{17.67cm}}{\bf\textcolor{white}{Types}} \tn % Row 0 \SetRowColor{LightBackground} fix & Correct code issue (Patch) & - \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} feat & Introduce new feature (Minor) & - \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} \seqsplit{BREAKING} CHANGE & Breaking backward compatibility (Major) & - \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} build & Build system changes & Angular \seqsplit{convention} \tn % Row Count 8 (+ 2) % Row 4 \SetRowColor{LightBackground} chore & Maintenance or tooling & Angular \seqsplit{convention} \tn % Row Count 10 (+ 2) % Row 5 \SetRowColor{white} ci & Continuous integration adjustments & Angular \seqsplit{convention} \tn % Row Count 12 (+ 2) % Row 6 \SetRowColor{LightBackground} docs & Documentation changes made & Angular \seqsplit{convention} \tn % Row Count 14 (+ 2) % Row 7 \SetRowColor{white} style & Code style updates & Angular \seqsplit{convention} \tn % Row Count 16 (+ 2) % Row 8 \SetRowColor{LightBackground} \seqsplit{refactor} & Code restructuring done & Angular \seqsplit{convention} \tn % Row Count 18 (+ 2) % Row 9 \SetRowColor{white} perf & Performance improvement made & Angular \seqsplit{convention} \tn % Row Count 20 (+ 2) % Row 10 \SetRowColor{LightBackground} test & Testing-related changes & Angular \seqsplit{convention} \tn % Row Count 22 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}---} \SetRowColor{LightBackground} \mymulticolumn{3}{x{17.67cm}}{Several types use words based on \{\{link="https://github.com/conventional-changelog/commitlint/tree/master/\%40commitlint/config-conventional"\}\}Angular's conventional commit\{\{/link\}\}.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}---} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{17.67cm}}{\bf\textcolor{white}{Specification}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} Commits MUST be prefixed with a type, which consists of a noun, feat, fix, etc., followed by the OPTIONAL scope, OPTIONAL !, and REQUIRED terminal colon and space.} \tn % Row Count 4 (+ 4) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} The type feat MUST be used when a commit adds a new feature to your application or library.} \tn % Row Count 7 (+ 3) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} The type fix MUST be used when a commit represents a bug fix for your application.} \tn % Row Count 10 (+ 3) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., fix(parser):} \tn % Row Count 14 (+ 4) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., fix: array parsing issue when multiple spaces were contained in string.} \tn % Row Count 19 (+ 5) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.} \tn % Row Count 24 (+ 5) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} A commit body is free-form and MAY consist of any number of newline separated paragraphs.} \tn % Row Count 27 (+ 3) % Row 7 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a :\textless{}space\textgreater{} or \textless{}space\textgreater{}\# separator, followed by a string value (this is inspired by the git trailer convention).} \tn % Row Count 33 (+ 6) \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{17.67cm}}{\bf\textcolor{white}{Specification (cont)}} \tn % Row 8 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} A footer's token MUST use - in place of whitespace characters, e.g., Acked-by (this helps differentiate the footer section from a multi-paragraph body). An exception is made for BREAKING CHANGE, which MAY also be used as a token.} \tn % Row Count 6 (+ 6) % Row 9 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} A footer's value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed.} \tn % Row Count 10 (+ 4) % Row 10 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the footer.} \tn % Row Count 13 (+ 3) % Row 11 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., BREAKING CHANGE: environment variables now take precedence over config files.} \tn % Row Count 18 (+ 5) % Row 12 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} If included in the type/scope prefix, breaking changes MUST be indicated by a ! immediately before the :. If ! is used, BREAKING CHANGE: MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change.} \tn % Row Count 24 (+ 6) % Row 13 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} Types other than feat and fix MAY be used in your commit messages, e.g., docs: update ref docs.} \tn % Row Count 27 (+ 3) % Row 14 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} The units of information that make up Conventional Commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.} \tn % Row Count 31 (+ 4) \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{17.67cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{17.67cm}}{\bf\textcolor{white}{Specification (cont)}} \tn % Row 15 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{\{\{fa-check-circle\}\} BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer.} \tn % Row Count 3 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \end{document}