2023-01-28 13:49:11 +00:00
<!DOCTYPE html>
2024-04-27 13:29:53 +00:00
< html lang = "en" dir = "ltr" itemscope itemtype = "http://schema.org/Article" >
2023-01-28 13:49:11 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2024-10-11 14:17:37 +00:00
< meta name = "generator" content = "Hugo 0.135.0" >
2024-10-13 15:22:56 +00:00
< meta name = "generator" content = "Relearn 7.0.0+72a36ea6e73e5941fb92069356655d9913bfb4b4" >
2023-01-28 13:49:11 +00:00
< meta name = "robots" content = "noindex, nofollow, noarchive, noimageindex" >
< meta name = "description" content = "What to know if you want to contribute" >
2023-10-10 21:22:41 +00:00
< meta name = "author" content = "Sören Weber" >
2023-10-11 16:03:03 +00:00
< meta name = "twitter:card" content = "summary_large_image" >
2024-02-24 13:03:50 +00:00
< meta name = "twitter:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2023-10-11 16:03:03 +00:00
< meta name = "twitter:title" content = "Contributing :: Hugo Relearn Theme" >
< meta name = "twitter:description" content = "What to know if you want to contribute" >
2024-10-13 14:26:50 +00:00
< meta property = "og:url" content = "https://mcshelby.github.io/hugo-theme-relearn/development/contributing/index.html" >
2024-04-07 13:13:19 +00:00
< meta property = "og:site_name" content = "Hugo Relearn Theme" >
2023-10-11 15:32:39 +00:00
< meta property = "og:title" content = "Contributing :: Hugo Relearn Theme" >
< meta property = "og:description" content = "What to know if you want to contribute" >
2024-04-07 13:13:19 +00:00
< meta property = "og:locale" content = "en" >
2023-10-11 15:32:39 +00:00
< meta property = "og:type" content = "website" >
2024-02-24 13:03:50 +00:00
< meta property = "og:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2024-04-24 19:38:41 +00:00
< 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" >
2024-10-13 14:26:50 +00:00
< meta itemprop = "keywords" content = "Explanation" >
2023-01-28 13:49:11 +00:00
< title > Contributing :: Hugo Relearn Theme< / title >
2024-10-13 14:26:50 +00:00
< 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" >
2024-10-13 15:22:56 +00:00
< link href = "/hugo-theme-relearn/images/logo.svg?1728832963" rel = "icon" type = "image/svg+xml" >
< link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1728832963" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1728832963" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/nucleus.css?1728832963" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/auto-complete.css?1728832963" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/auto-complete.css?1728832963" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/perfect-scrollbar.min.css?1728832963" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/fonts.css?1728832963" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fonts.css?1728832963" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/theme.css?1728832963" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/theme-relearn-auto.css?1728832963" rel = "stylesheet" id = "R-variant-style" >
< link href = "/hugo-theme-relearn/css/chroma-relearn-auto.css?1728832963" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "/hugo-theme-relearn/css/print.css?1728832963" rel = "stylesheet" media = "print" >
< link href = "/hugo-theme-relearn/css/format-print.css?1728832963" rel = "stylesheet" >
< script src = "/hugo-theme-relearn/js/variant.js?1728832963" > < / script >
2024-03-16 13:44:28 +00:00
< script >
2023-11-16 22:53:34 +00:00
window.relearn = window.relearn || {};
2024-03-18 20:59:19 +00:00
window.relearn.relBasePath='..\/..';
window.relearn.relBaseUri='..\/..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
2024-08-22 16:34:04 +00:00
window.relearn.disableAnchorCopy=false;
window.relearn.disableAnchorScrolling=false;
2023-11-16 22:53:34 +00:00
// variant stuff
2024-04-19 06:38:17 +00:00
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' ] );
2023-11-16 22:53:34 +00:00
// 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}"`;
2023-01-28 13:49:11 +00:00
< / script >
< style >
2023-09-23 08:19:35 +00:00
#R-body img.bg-white {
2023-01-28 13:49:11 +00:00
background-color: white;
}
< / style >
< / head >
2024-10-13 14:26:50 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "/hugo-theme-relearn/development/contributing/index.html" >
2023-09-23 08:19:35 +00:00
< div id = "R-body" class = "default-animation" >
< div id = "R-body-overlay" > < / div >
< nav id = "R-topbar" >
2023-09-18 18:49:44 +00:00
< div class = "topbar-wrapper" >
2023-09-13 21:30:04 +00:00
< div class = "topbar-sidebar-divider" > < / div >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-start" data-area = "start" >
2023-12-05 07:41:41 +00:00
< 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 >
2023-09-12 21:10:21 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< 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 >
2023-09-13 21:30:04 +00:00
< / div >
2023-09-20 22:28:27 +00:00
< ol class = "topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype = "http://schema.org/BreadcrumbList" > < li
2024-10-13 14:26:50 +00:00
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
2023-09-23 22:28:49 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< span itemprop = "name" > Contributing< / span > < meta itemprop = "position" content = "2" > < / li >
2023-09-13 21:30:04 +00:00
< / ol >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-end" data-area = "end" >
2024-10-13 14:26:50 +00:00
< 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 >
2024-04-07 19:58:38 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< 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 >
2024-04-07 19:58:38 +00:00
< / div >
2023-09-12 21:19:47 +00:00
< / div >
2023-01-28 13:49:11 +00:00
< / div >
< / nav >
2023-09-23 08:19:35 +00:00
< div id = "R-main-overlay" > < / div >
2024-10-13 14:26:50 +00:00
< main id = "R-body-inner" class = "highlightable development" tabindex = "-1" >
2023-01-28 13:49:11 +00:00
< div class = "flex-block-wrapper" >
2024-10-13 14:26:50 +00:00
< article class = "default" >
< header class = "headline" >
< / header >
2024-04-07 19:58:38 +00:00
2023-01-28 13:49:11 +00:00
< h1 id = "contributing" > Contributing< / h1 >
< h2 id = "code-quality" > Code Quality< / h2 >
2024-04-21 21:48:09 +00:00
< 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 >
2023-01-28 13:49:11 +00:00
< 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 >
2024-10-13 14:26:50 +00:00
< 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 >
2023-01-28 13:49:11 +00:00
< 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 >
2024-04-21 21:48:09 +00:00
< 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 >
2024-04-12 15:30:57 +00:00
< p > Following is an inpomplete list of some of the used conventional commit types. Be creative.< / p >
2023-01-28 13:49:11 +00:00
< table >
2024-09-03 17:09:09 +00:00
< thead >
< tr >
< th style = "text-align: left" > Common< / th >
< th style = "text-align: left" > Feature< / th >
< th style = "text-align: left" > Structure< / th >
< th style = "text-align: left" > Shortcodes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align: left" > build< / td >
< td style = "text-align: left" > a11y< / td >
< td style = "text-align: left" > favicon< / td >
< td style = "text-align: left" > attachments< / td >
< / tr >
< tr >
< td style = "text-align: left" > browser< / td >
< td style = "text-align: left" > archetypes< / td >
< td style = "text-align: left" > search< / td >
< td style = "text-align: left" > badge< / td >
< / tr >
< tr >
< td style = "text-align: left" > chore< / td >
< td style = "text-align: left" > alias< / td >
< td style = "text-align: left" > menu< / td >
< td style = "text-align: left" > button< / td >
< / tr >
< tr >
< td style = "text-align: left" > docs< / td >
< td style = "text-align: left" > generator< / td >
< td style = "text-align: left" > history< / td >
< td style = "text-align: left" > children< / td >
< / tr >
< tr >
< td style = "text-align: left" > shortcodes< / td >
< td style = "text-align: left" > i18n< / td >
< td style = "text-align: left" > scrollbar< / td >
< td style = "text-align: left" > expand< / td >
< / tr >
< tr >
< td style = "text-align: left" > theme< / td >
< td style = "text-align: left" > mobile< / td >
< td style = "text-align: left" > nav< / td >
< td style = "text-align: left" > icon< / td >
< / tr >
< tr >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > print< / td >
< td style = "text-align: left" > toc< / td >
< td style = "text-align: left" > include< / td >
< / tr >
< tr >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > rss< / td >
< td style = "text-align: left" > clipboard< / td >
< td style = "text-align: left" > math< / td >
< / tr >
< tr >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > variant< / td >
< td style = "text-align: left" > syntaxhighlight< / td >
< td style = "text-align: left" > mermaid< / td >
< / tr >
< tr >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > boxes< / td >
< td style = "text-align: left" > notice< / td >
< / tr >
< tr >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > openapi< / td >
< / tr >
< tr >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > piratify< / td >
< / tr >
< tr >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > siteparam< / td >
< / tr >
< tr >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > < / td >
< td style = "text-align: left" > tabs< / td >
< / tr >
< / tbody >
2023-01-28 13:49:11 +00:00
< / table >
2024-10-13 14:26:50 +00:00
< 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 >
2023-01-28 13:49:11 +00:00
< / div >
< / main >
< / div >
2024-10-13 15:22:56 +00:00
< script src = "/hugo-theme-relearn/js/clipboard.min.js?1728832963" defer > < / script >
< script src = "/hugo-theme-relearn/js/perfect-scrollbar.min.js?1728832963" defer > < / script >
< script src = "/hugo-theme-relearn/js/theme.js?1728832963" defer > < / script >
2023-01-28 13:49:11 +00:00
< / body >
< / html >
