<!DOCTYPE html> <html lang="en" dir="ltr" itemscope itemtype="http://schema.org/Article"> <head> <meta charset="utf-8"> <meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0"> <meta name="generator" content="Hugo 0.138.0"> <meta name="generator" content="Relearn 7.1.1+a22e183c515325d57bb952f023483fd0f0dcc453"> <meta name="robots" content="noindex, nofollow, noarchive, noimageindex"> <meta name="description" content="What to know if you want to contribute"> <meta name="author" content="Sören Weber"> <meta name="twitter:card" content="summary_large_image"> <meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png"> <meta name="twitter:title" content="Contributing :: Hugo Relearn Theme"> <meta name="twitter:description" content="What to know if you want to contribute"> <meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/development/contributing/index.html"> <meta property="og:site_name" content="Hugo Relearn Theme"> <meta property="og:title" content="Contributing :: Hugo Relearn Theme"> <meta property="og:description" content="What to know if you want to contribute"> <meta property="og:locale" content="en"> <meta property="og:type" content="website"> <meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png"> <meta itemprop="name" content="Contributing :: Hugo Relearn Theme"> <meta itemprop="description" content="What to know if you want to contribute"> <meta itemprop="wordCount" content="197"> <meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png"> <meta itemprop="keywords" content="Explanation"> <title>Contributing :: Hugo Relearn Theme</title> <link href="https://mcshelby.github.io/hugo-theme-relearn/development/contributing/index.html" rel="alternate" hreflang="x-default"> <link href="https://mcshelby.github.io/hugo-theme-relearn/development/contributing/index.html" rel="alternate" hreflang="en"> <link href="https://mcshelby.github.io/hugo-theme-relearn/pir/development/contributing/index.html" rel="alternate" hreflang="art-x-pir"> <link href="https://mcshelby.github.io/hugo-theme-relearn/development/contributing/index.html" rel="canonical" type="text/html" title="Contributing :: Hugo Relearn Theme"> <link href="/hugo-theme-relearn/development/contributing/index.xml" rel="alternate" type="application/rss+xml" title="Contributing :: Hugo Relearn Theme"> <link href="/hugo-theme-relearn/images/logo.svg?1731885648" rel="icon" type="image/svg+xml"> <link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1731885648" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1731885648" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/nucleus.css?1731885648" rel="stylesheet"> <link href="/hugo-theme-relearn/css/auto-complete.css?1731885648" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1731885648" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1731885648" rel="stylesheet"> <link href="/hugo-theme-relearn/css/fonts.css?1731885648" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1731885648" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/theme.css?1731885648" rel="stylesheet"> <link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1731885648" rel="stylesheet" id="R-variant-style"> <link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1731885648" rel="stylesheet" id="R-variant-chroma-style"> <link href="/hugo-theme-relearn/css/print.css?1731885648" rel="stylesheet" media="print"> <link href="/hugo-theme-relearn/css/format-print.css?1731885648" rel="stylesheet"> <script src="/hugo-theme-relearn/js/variant.js?1731885648"></script> <script> window.relearn = window.relearn || {}; window.relearn.relBasePath='..\/..'; window.relearn.relBaseUri='..\/..\/..'; window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn'; window.relearn.disableAnchorCopy=false; window.relearn.disableAnchorScrolling=false; // variant stuff window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] ); // translations window.T_Copy_to_clipboard = `Copy to clipboard`; window.T_Copied_to_clipboard = `Copied to clipboard!`; window.T_Copy_link_to_clipboard = `Copy link to clipboard`; window.T_Link_copied_to_clipboard = `Copied link to clipboard!`; window.T_Reset_view = `Reset view`; window.T_View_reset = `View reset!`; window.T_No_results_found = `No results found for "{0}"`; window.T_N_results_found = `{1} results found for "{0}"`; </script> <style> #R-body img.bg-white { background-color: white; } </style> </head> <body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/development/contributing/index.html"> <div id="R-body" class="default-animation"> <div id="R-body-overlay"></div> <nav id="R-topbar"> <div class="topbar-wrapper"> <div class="topbar-sidebar-divider"></div> <div class="topbar-area topbar-area-start" data-area="start"> <div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide"><button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL+ALT+n)"><i class="fa-fw fas fa-bars"></i></button> </div> <div class="topbar-button topbar-button-toc" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="Table of Contents (CTRL+ALT+t)"><i class="fa-fw fas fa-list-alt"></i></button> <div class="topbar-content"> <div class="topbar-content-wrapper"> <nav class="TableOfContents"> <ul> <li><a href="#code-quality">Code Quality</a></li> <li><a href="#conventional-commits">Conventional Commits</a></li> </ul> </nav> </div> </div> </div> </div> <ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="/hugo-theme-relearn/development/index.html"><span itemprop="name">Development</span></a><meta itemprop="position" content="1"> > </li><li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Contributing</span><meta itemprop="position" content="2"></li> </ol> <div class="topbar-area topbar-area-end" data-area="end"> <div class="topbar-button topbar-button-edit" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/development/contributing/_index.en.md" target="_self" title="Edit (CTRL+ALT+w)"><i class="fa-fw fas fa-pen"></i></a> </div> <div class="topbar-button topbar-button-print" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/development/contributing/index.print.html" title="Print whole chapter (CTRL+ALT+p)"><i class="fa-fw fas fa-print"></i></a> </div> <div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/development/index.html" title="Development (🡐)"><i class="fa-fw fas fa-chevron-left"></i></a> </div> <div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/development/maintaining/index.html" title="Maintaining (🡒)"><i class="fa-fw fas fa-chevron-right"></i></a> </div> <div class="topbar-button topbar-button-more" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="More"><i class="fa-fw fas fa-ellipsis-v"></i></button> <div class="topbar-content"> <div class="topbar-content-wrapper"> <div class="topbar-area topbar-area-more" data-area="more"> </div> </div> </div> </div> </div> </div> </nav> <div id="R-main-overlay"></div> <main id="R-body-inner" class="highlightable development" tabindex="-1"> <div class="flex-block-wrapper"> <article class="default"> <header class="headline"> </header> <h1 id="contributing">Contributing</h1> <h2 id="code-quality">Code Quality</h2> <p>A new release can happen at any time from the <code>main</code> branch of the <a href="https://github.com/McShelby/hugo-theme-relearn" rel="external" target="_self">GitHub project</a> without further acknowledgment. This makes it necessary that, every pushed set of changesets into the <code>main</code> branch <strong>must</strong> be self-contained and correct, resulting in a releasable version.</p> <p>Stay simple for the user by focusing on the mantra “convention over configuration”.</p> <p>At installation the site should work reasonable without (m)any configuration.</p> <p>Stay close to the Hugo way.</p> <p>Don’t use npm or any preprocessing, our contributors may not be front-end developers.</p> <p>Document new features in the exampleSite. This also contains entries to the <a href="/hugo-theme-relearn/introduction/releasenotes/index.html">What’s new</a> page.</p> <p>Don’t break existing features if you don’t have to.</p> <p>Remove reported issue from the browser’s console.</p> <p>Check for unnecessary whitespace and correct indention of your resulting HTML.</p> <h2 id="conventional-commits">Conventional Commits</h2> <p>Write commit messages in the <a href="https://www.conventionalcommits.org/en/v1.0.0/" rel="external" target="_self">conventional commit</a> format.</p> <p>Following is an inpomplete list of some of the used conventional commit types. Be creative.</p> <table> <thead> <tr> <th>Common</th> <th>Feature</th> <th>Structure</th> <th>Shortcodes</th> </tr> </thead> <tbody> <tr> <td>build</td> <td>a11y</td> <td>favicon</td> <td>attachments</td> </tr> <tr> <td>browser</td> <td>archetypes</td> <td>search</td> <td>badge</td> </tr> <tr> <td>chore</td> <td>alias</td> <td>menu</td> <td>button</td> </tr> <tr> <td>docs</td> <td>generator</td> <td>history</td> <td>children</td> </tr> <tr> <td>shortcodes</td> <td>i18n</td> <td>scrollbar</td> <td>expand</td> </tr> <tr> <td>theme</td> <td>mobile</td> <td>nav</td> <td>icon</td> </tr> <tr> <td></td> <td>print</td> <td>toc</td> <td>include</td> </tr> <tr> <td></td> <td>rss</td> <td>clipboard</td> <td>math</td> </tr> <tr> <td></td> <td>variant</td> <td>syntaxhighlight</td> <td>mermaid</td> </tr> <tr> <td></td> <td></td> <td>boxes</td> <td>notice</td> </tr> <tr> <td></td> <td></td> <td></td> <td>openapi</td> </tr> <tr> <td></td> <td></td> <td></td> <td>piratify</td> </tr> <tr> <td></td> <td></td> <td></td> <td>siteparam</td> </tr> <tr> <td></td> <td></td> <td></td> <td>tabs</td> </tr> </tbody> </table> <footer class="footline"> <div class="R-taxonomy taxonomy-categories cstyle" title="Categories" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);"> <i class="fa-fw fas fa-layer-group"></i> <ul> <li><a class="term-link" href="/hugo-theme-relearn/categories/explanation/index.html">Explanation</a></li> </ul> </div> </footer> </article> </div> </main> </div> <script src="/hugo-theme-relearn/js/clipboard.min.js?1731885648" defer></script> <script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1731885648" defer></script> <script src="/hugo-theme-relearn/js/theme.js?1731885648" defer></script> </body> </html>