\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{py6jlb} \pdfinfo{ /Title (git-commit-message.pdf) /Creator (Cheatography) /Author (py6jlb) /Subject (Git commit message 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}{1D3043} \definecolor{LightBackground}{HTML}{F7F8F9} \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{Git commit message Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{py6jlb} via \textcolor{DarkBackground}{\uline{cheatography.com/179964/cs/37439/}}} \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}py6jlb \\ \uline{cheatography.com/py6jlb} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 2nd March, 2023.\\ Updated 2nd March, 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{multicols*}{2} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Шаблон сообщения}} \tn \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{!type(?scope): !subject \newline % Row Count 1 (+ 1) \textless{}?body\textgreater{} \newline % Row Count 2 (+ 1) \textless{}?footer\textgreater{}% Row Count 3 (+ 1) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{1.36 cm} x{6.64 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{type: типы коммитов}} \tn % Row 0 \SetRowColor{LightBackground} test & указывает на любое создание или изменение кода тестов. Пример — создание модульных тестов. \tn % Row Count 6 (+ 6) % Row 1 \SetRowColor{white} feat & указывает на разработку новой функции для проекта. Примеры: добавление сервиса, \seqsplit{функциональности}, конечной точки и т.д. \tn % Row Count 13 (+ 7) % Row 2 \SetRowColor{LightBackground} \seqsplit{refactor} & используется, когда происходит рефакторинг кода, не влияющий на \seqsplit{логику/правила} системы. Пример — изменения после ревью кода. \tn % Row Count 20 (+ 7) % Row 3 \SetRowColor{white} style & используется при изменениях \seqsplit{форматирования} и стиля кода, которые никак не меняют систему. Примеры: смена руководства по стилю или соглашения о линтинге, исправление отступов, удаление пробелов, удаление комментариев и т.д…. \tn % Row Count 33 (+ 13) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{1.36 cm} x{6.64 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{type: типы коммитов (cont)}} \tn % Row 4 \SetRowColor{LightBackground} fix & используется при исправлении ошибок, которые порождают баги в системе. Пример — применение обработки для функции, которая ведет себя не так, как ожидалось, и возвращает ошибку. \tn % Row Count 10 (+ 10) % Row 5 \SetRowColor{white} chore & указывает на изменения в проекте, которые не влияют на систему или тестовые файлы. Это изменения, связанные с разработкой. Примеры: изменение правил для eslint, добавление prettier, добавление расширений файлов в .gitignore. \tn % Row Count 22 (+ 12) % Row 6 \SetRowColor{LightBackground} docs & используется при изменениях в документации проекта. Пример: добавление сведений в документацию API, измение README и т.д. \tn % Row Count 29 (+ 7) % Row 7 \SetRowColor{white} build & используется для указания изменений, которые влияют на процесс сборки проекта, или внешних \seqsplit{зависимостей.} Примеры: Gulp, \seqsplit{добавление/удаление} зависимостей npm и т.д.. \tn % Row Count 38 (+ 9) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{1.36 cm} x{6.64 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{type: типы коммитов (cont)}} \tn % Row 8 \SetRowColor{LightBackground} perf & указывает на изменение, которое улучшает \seqsplit{производительность} системы. Пример — замена ForEach на While. \tn % Row Count 6 (+ 6) % Row 9 \SetRowColor{white} ci & используется для указания на изменения в \seqsplit{конфигурационных} файлах CI. Примеры: Circle, Travis, BrowserStack и т.д. \tn % Row Count 12 (+ 6) % Row 10 \SetRowColor{LightBackground} \seqsplit{revert} & указывает на отмену предыдущего коммита. \tn % Row Count 15 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{subject: сообщение коммита}} \tn \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Мы сообщаем нашей команде, что сделает коммит, если его применить. В английском языке нужно использовать \seqsplit{повелительное} наклонение, а не прошедшее время. \newline % Row Count 6 (+ 6) Пример: «If applied, this commit will…». \newline % Row Count 8 (+ 2) Аналог на русском: «При применении этот коммит \textless{}что сделает?\textgreater{}».% Row Count 11 (+ 3) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{scope: контекст коммита}} \tn \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Прочитав тип коммита и его сообщение, разработчик уже легко поймет, какое изменение было внесено и что принесет этот коммит, если его применить. \newline % Row Count 6 (+ 6) Несмотря на то, что атрибут scope не является обязательным, его можно использовать для добавления контекста. Это позволит сделать сообщение коммита максимально кратким и лаконичным. Помните, что область действия нужно указывать в скобках. Разделяются скоупы символом /.% Row Count 16 (+ 10) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Прмер :git commit -m "feat(UserService): добавляет /getAppointments эндпоит"} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Примечания}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Для каждого коммита указывается только один тип.} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{type — обязательный атрибут.} \tn % Row Count 3 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Если вы не знаете, какой тип использовать, вероятно, это большое изменение, и можно разделить этот коммит на два или на большее число коммитов.} \tn % Row Count 9 (+ 6) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Разница между build и chore может быть довольно тонкой, что может привести к путанице. Поэтому важно знать, какой тип когда \seqsplit{использовать.} В случае с Node.js, например, мы можем считать, что когда происходит \seqsplit{добавление/изменение} определенной зависимости разработки, \seqsplit{присутствующей} в devDependencies, мы используем chore. Для \seqsplit{изменений/добавлений} общих зависимостей проекта, которые оказывают прямое и реальное влияние на систему, мы используем build.} \tn % Row Count 25 (+ 16) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Прмеры}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{git commit -m "test: добавляет тесты проверки \seqsplit{автоматического} создания продукта"} \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{git commit -m "feat: добавляет реализацию сервиса отслеживания продуктов"} \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{git commit -m "chore: добавляет правило no-ubdef в eslintrc.json"} \tn % Row Count 8 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}