\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{marco.lizza} \pdfinfo{ /Title (conventional-commits-v1.pdf) /Creator (Cheatography) /Author (marco.lizza) /Subject (Conventional Commits v1 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}{A3A3A3} \definecolor{LightBackground}{HTML}{F3F3F3} \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 v1 Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{marco.lizza} via \textcolor{DarkBackground}{\uline{cheatography.com/191583/cs/39815/}}} \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}marco.lizza \\ \uline{cheatography.com/marco-lizza} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 8th August, 2023.\\ Updated 8th August, 2023.\\ 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}{Commit message structure}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{{\bf{\textless{}type\textgreater{}}}{[}scope{]}: {\bf{\textless{}description\textgreater{}}} \newline \newline {[}body{]} \newline \newline {[}footer{]}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{A commit that has the text `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.454 cm} x{13.816 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{17.67cm}}{\bf\textcolor{white}{Types}} \tn % Row 0 \SetRowColor{LightBackground} `feat` & A new feature \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} `fix` & A bug fix \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} `docs` & Documentation only changes \tn % Row Count 3 (+ 1) % Row 3 \SetRowColor{white} `style` & Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) \tn % Row Count 7 (+ 4) % Row 4 \SetRowColor{LightBackground} \seqsplit{`refactor`} & A code change that neither fixes a bug nor adds a feature \tn % Row Count 9 (+ 2) % Row 5 \SetRowColor{white} `perf` & A code change that improves performance \tn % Row Count 11 (+ 2) % Row 6 \SetRowColor{LightBackground} `test` & Adding missing tests or correcting existing tests \tn % Row Count 13 (+ 2) % Row 7 \SetRowColor{white} `build` & Changes that affect the build system or external dependencies (e.g. Gradle, Maven) \tn % Row Count 16 (+ 3) % Row 8 \SetRowColor{LightBackground} `ci` & Changes to our CI configuration files and scripts (e.g. GitLab, Jenkins) \tn % Row Count 19 (+ 3) % Row 9 \SetRowColor{white} `chore` & Other changes that don't modify src or test files \tn % Row Count 21 (+ 2) % Row 10 \SetRowColor{LightBackground} \seqsplit{`revert`} & Reverts a previous commit \tn % Row Count 22 (+ 1) \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}}{{\bf{1.}} Commits {\bf{MUST}} be prefixed with a type, which consists of a verb, `feat`, `fix`, etc., followed by a colon and a space.} \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{{\bf{2.}} The type `feat` {\bf{MUST}} be used when a commit adds a new feature to your application or library.} \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{{\bf{3.}} The type `fix` {\bf{MUST}} be used when a commit represents a bug fix for your application.} \tn % Row Count 8 (+ 2) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{{\bf{4.}} An optional scope {\bf{MAY}} be provided after a type. A scope is a phrase describing a section of the codebase enclosed in parenthesis (e.g. `fix(parser):`).} \tn % Row Count 12 (+ 4) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{{\bf{5.}} A description {\bf{MUST}} immediately follow the type/scope prefix. The description is a short description of the pull request (e.g., `fix: array parsing issue when multiple spaces were contained in string`).} \tn % Row Count 17 (+ 5) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{{\bf{6.}} A longer commit body {\bf{MAY}} be provided after the short description. The body {\bf{MUST}} begin one blank line after the description.} \tn % Row Count 20 (+ 3) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{{\bf{7.}} A footer {\bf{MAY}} be provided one blank line after the body. The footer SHOULD contain additional meta-information about the pull-request (such as the issues it fixes, e.g., `fixes \#13, \#5`).} \tn % Row Count 24 (+ 4) % Row 7 \SetRowColor{white} \mymulticolumn{1}{x{17.67cm}}{{\bf{8.}} Breaking changes {\bf{MUST}} be indicated at the very beginning of the footer or body section of a commit. A breaking change {\bf{MUST}} consist of the uppercase text `BREAKING CHANGE`, followed by a colon and a space.} \tn % Row Count 29 (+ 5) % Row 8 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{{\bf{9.}} A description {\bf{MUST}} be provided after the BREAKING CHANGE: , describing what has changed about the API (e.g. `BREAKING CHANGE: environment variables now take precedence over config files`).} \tn % Row Count 33 (+ 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 9 \SetRowColor{LightBackground} \mymulticolumn{1}{x{17.67cm}}{{\bf{10.}} Types other than `feat` and `fix` {\bf{MAY}} be used in your commit messages.} \tn % Row Count 2 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \end{document}