\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{Jack Collier (imnotquitejack)} \pdfinfo{ /Title (software-development-best-practices.pdf) /Creator (Cheatography) /Author (Jack Collier (imnotquitejack)) /Subject (Software Development Best Practices 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}{1A63A3} \definecolor{LightBackground}{HTML}{F0F5F9} \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{Software Development Best Practices Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Jack Collier (imnotquitejack)} via \textcolor{DarkBackground}{\uline{cheatography.com/105373/cs/21383/}}} \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}Jack Collier (imnotquitejack) \\ \uline{cheatography.com/imnotquitejack} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Not Yet Published.\\ Updated 10th June, 2021.\\ 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*}{3} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Linters}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Use \{\{popup="https://rubocop.org/"\}\}rubocop\{\{/popup\}\}.} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Commit linter configuration to project repo for the team to share.} \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Ensure that linter configuration is \{\{popup="https://marketplace.visualstudio.com/items?itemName=misogi.ruby-rubocop"\}\}integrated into your IDE\{\{/popup\}\}.} \tn % Row Count 8 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{2.4885 cm} x{2.4885 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Code Quality : Static Analyzers}} \tn % Row 0 \SetRowColor{LightBackground} \{\{popup="https://codeclimate.com/quality/"\}\}CodeClimate\{\{/popup\}\} & Static analysis of code quality, SaaS \tn % Row Count 4 (+ 4) % Row 1 \SetRowColor{white} \{\{popup="https://www.sonarqube.org/features/quality-gate/"\}\}SonarQube\{\{/popup\}\} & Comprehensive static analysis of code quality, can run locally \tn % Row Count 8 (+ 4) % Row 2 \SetRowColor{LightBackground} \{\{popup="https://github.com/whitesmith/rubycritic"\}\}Ruby Critic\{\{/popup\}\} & Ruby static analysis gem \tn % Row Count 12 (+ 4) % Row 3 \SetRowColor{white} \{\{popup="https://rubocop.org/"\}\}Rubocop\{\{/popup\}\} & Code style analysis \& feedback, can integrate with IDE \tn % Row Count 15 (+ 3) % Row 4 \SetRowColor{LightBackground} \{\{popup="https://semgrep.dev/"\}\}Semgrep\{\{/popup\}\} & Static analysis for lots of languages \tn % Row Count 18 (+ 3) % Row 5 \SetRowColor{white} \{\{popup="https://github.com/flyerhzm/rails\_best\_practices"\}\}rails\_best\_practices\{\{/popup\}\} & Check the quality of your Ruby on Rails code \tn % Row Count 23 (+ 5) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Pull Requests}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{PRs should be as small and incremental as possible} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Include screenshots / animations when appropriate} \tn % Row Count 3 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{All CI tests should pass prior to assigning reviewers} \tn % Row Count 5 (+ 2) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Don't take feedback personally! Receiving and learning from criticism is one of the best ways to become a better software developer.} \tn % Row Count 8 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Security}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Always stay up to date on the \{\{popup="https://owasp.org/www-project-top-ten/"\}\}OWASP Top Ten security risks\{\{/popup\}\}.} \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Integrate static analysis security tools into CI. Dependency auditing is an easy place to start. Enable \{\{popup="https://docs.github.com/en/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates"\}\}Github's Dependabot\{\{/popup\}\}.} \tn % Row Count 10 (+ 7) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Use the \{\{popup="https://www.ssllabs.com/ssltest/"\}\}Qualys SSL Server Test\{\{/popup\}\} to ensure that SSL is correctly configured.} \tn % Row Count 13 (+ 3) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Always require SSL. \{\{popup="https://letsencrypt.org/"\}\}Let's Encrypt\{\{/popup\}\} provides free, secure certificates.} \tn % Row Count 16 (+ 3) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Use \{\{popup="https://github.com/rubysec/bundler-audit"\}\}bundler-audit\{\{/popup\}\} and \{\{popup="https://brakemanscanner.org/"\}\}brakeman\{\{/popup\}\}} \tn % Row Count 19 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Testing}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Unit Tests}} : test the output of a single given state} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{{\bf{Functional Tests}} : test the output of changes to state} \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Integration Tests}} : test the results of cross-service interactions from the user's perspective. Use \{\{popup="https://www.cypress.io/"\}\}Cypress\{\{/popup\}\}.} \tn % Row Count 8 (+ 4) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Implement {\bf{continuous integration}}, which runs all tests, performs static analysis, and automates security audits.} \tn % Row Count 11 (+ 3) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Ensure that {\bf{test coverage}} is over 95\%.} \tn % Row Count 12 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Performance}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Identify and eliminate N+1 queries. \{\{popup="https://github.com/flyerhzm/bullet"\}\}bullet\{\{/popup\}\} is helpful.} \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{An RPM like \{\{popup="https://newrelic.com/"\}\}New Relic\{\{/popup\}\}, \{\{popup="https://scoutapm.com/"\}\}Scout\{\{/popup\}\}, or \{\{popup="https://www.datadoghq.com/"\}\}DataDog\{\{/popup\}\} is great for identifying performance problems.} \tn % Row Count 8 (+ 5) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Ensure that GZIP / HTTP Deflate are enabled and properly configured.} \tn % Row Count 10 (+ 2) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Use \{\{popup="https://guides.rubyonrails.org/caching\_with\_rails.html"\}\}Rails caching\{\{/popup\}\}. It includes easy-to-implement patterns for lots of different types of caching.} \tn % Row Count 14 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Documentation}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{`README.md` must include these sections: Summary, Prerequisites, Infrastructure, ENV Variables, Cron, Gotchas} \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Use \{\{link="https://semver.org/"\}\}semantic versioning\{\{/link\}\}.} \tn % Row Count 5 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{`CHANGELOG.md` should follow \seqsplit{https://keepachangelog.com/en/1.0.0/}} \tn % Row Count 7 (+ 2) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Provide well-formatted and sensical {\bf{seed data}}.} \tn % Row Count 8 (+ 1) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Diagram {\bf{complex processes}}. \{\{link="https://whimsical.com/"\}\}Whimsical\{\{/link\}\} is great for this.} \tn % Row Count 11 (+ 3) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{APIs should have comprehensive \{\{link="https://swagger.io/"\}\}Swagger\{\{/link\}\} documentation.} \tn % Row Count 13 (+ 2) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Frontends should have {\bf{wireframes}} prior to writing code.} \tn % Row Count 15 (+ 2) % Row 7 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{{\bf{Pivotal / Jira}} stories document application evolution.} \tn % Row Count 17 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Always consider the perspective of a developer who has never touched this project, but needs to rescue it because you're on vacation.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}