2023-01-28 13:49:11 +00:00
<!DOCTYPE html>
2023-02-08 21:24:18 +00:00
< html lang = "pir" dir = "rtl" >
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" >
2023-09-26 19:28:12 +00:00
< meta name = "generator" content = "Hugo 0.119.0" >
2023-10-02 09:45:01 +00:00
< meta name = "generator" content = "Relearn 5.22.1+tip" >
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" >
< meta name = "twitter:image" content = "https://McShelby.github.io/hugo-theme-relearn/images/hero.png" >
< meta name = "twitter:title" content = "Contributing :: Cap'n Hugo Relearrrn Theme" >
< meta name = "twitter:description" content = "What to know if you want to contribute" >
2023-10-11 15:32:39 +00:00
< meta property = "og:title" content = "Contributing :: Cap'n Hugo Relearrrn Theme" >
< meta property = "og:description" content = "What to know if you want to contribute" >
< meta property = "og:type" content = "website" >
2023-10-11 15:42:11 +00:00
< meta property = "og:url" content = "https://McShelby.github.io/hugo-theme-relearn/pir/dev/contributing/index.html" >
2023-10-11 15:32:39 +00:00
< meta property = "og:image" content = "https://McShelby.github.io/hugo-theme-relearn/images/hero.png" >
< meta property = "og:site_name" content = "Cap'n Hugo Relearrrn Theme" >
2023-01-28 13:49:11 +00:00
< title > Contributing :: Cap' n Hugo Relearrrn Theme< / title >
< link href = "https://McShelby.github.io/hugo-theme-relearn/dev/contributing/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/dev/contributing/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/pir/dev/contributing/index.html" rel = "alternate" hreflang = "pir" >
2023-10-28 22:03:53 +00:00
< link href = "../../../images/logo.svg?1698530626" rel = "icon" type = "image/svg+xml" >
2023-01-28 13:49:11 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2023-10-28 22:03:53 +00:00
< link href = "../../../css/fontawesome-all.min.css?1698530629" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../../css/fontawesome-all.min.css?1698530629" rel = "stylesheet" > < / noscript >
< link href = "../../../css/nucleus.css?1698530629" rel = "stylesheet" >
< link href = "../../../css/auto-complete.css?1698530629" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../../css/auto-complete.css?1698530629" rel = "stylesheet" > < / noscript >
< link href = "../../../css/perfect-scrollbar.min.css?1698530629" rel = "stylesheet" >
< link href = "../../../css/fonts.css?1698530629" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../../css/fonts.css?1698530629" rel = "stylesheet" > < / noscript >
< link href = "../../../css/theme.css?1698530629" rel = "stylesheet" >
< link href = "../../../css/theme-auto.css?1698530629" rel = "stylesheet" id = "R-variant-style" >
< link href = "../../../css/variant.css?1698530629" rel = "stylesheet" >
< link href = "../../../css/print.css?1698530629" rel = "stylesheet" media = "print" >
< link href = "../../../css/format-print.css?1698530629" rel = "stylesheet" >
< link href = "../../../css/ie.css?1698530629" rel = "stylesheet" >
< script src = "../../../js/url.js?1698530629" > < / script >
< script src = "../../../js/variant.js?1698530629" > < / script >
2023-01-28 13:49:11 +00:00
< script >
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
window.index_js_url="../../../pir/index.search.js";
var root_url="../../../";
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy t\u0027 clipboard';
window.T_Copied_to_clipboard = 'Copied t\u0027 clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link t\u0027 clipboard';
window.T_Link_copied_to_clipboard = 'Copied link t\u0027 clipboard!';
2023-09-26 20:26:46 +00:00
window.T_Reset_view = 'Rrreset view';
2023-10-01 10:25:48 +00:00
window.T_View_reset = 'View rrreset!';
2023-01-28 13:49:11 +00:00
window.T_No_results_found = 'No rrresults found fer \u0022{0}\u0022';
window.T_N_results_found = '{1} rrresults found fer \u0022{0}\u0022';
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
2023-08-12 14:11:21 +00:00
window.variants & & variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
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 >
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../../../pir/dev/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" >
< 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)" >
2023-09-12 21:10:21 +00:00
< i class = "fa-fw fas fa-bars" > < / i >
< / button >
< / 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
2023-09-26 20:26:46 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< a itemprop = "item" href = "../../../pir/dev/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" >
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 >
< main id = "R-body-inner" class = "highlightable default" tabindex = "-1" >
2023-01-28 13:49:11 +00:00
< div class = "flex-block-wrapper" >
< article class = "default" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2023-01-28 13:49:11 +00:00
< h1 id = "contributing" > Contributing< / h1 >
< h2 id = "code-quality" > Code Quality< / h2 >
2023-10-28 20:28:18 +00:00
< p > A new release can happen at any time from th' < code > main< / code > branch o' th' < a href = "https://github.com/McShelby/hugo-theme-relearn" target = "_blank" > GitHub project< / a > without further accknowledgment. This makes it necessary that, every pushed set o' changesets into th' < code > main< / code > branch < strong > must< / strong > be self-contained an' correct, result'n 'n a releas'ble version.< / p >
2023-01-28 13:49:11 +00:00
< p > Stay simple fer th' user by focus'n on th' mantra “ convent'n over configuration” .< / p >
< p > At installat'n th' ship should work reason'ble without (m)any configurat'n.< / p >
< p > Stay close t' th' Cap'n Hugo way.< / p >
< p > Don’ t use npm or any preprocess'n, our contributors may not be front-end developers.< / p >
2023-10-28 20:28:18 +00:00
< p > Document new features 'n th' exampleSite. This also contains entries t' th' < a href = "../../../basics/migration/index.html" > What’ s new< / a > plank.< / p >
2023-01-28 13:49:11 +00:00
< p > Don’ t break exist'n features if ye don’ t have t'.< / p >
< p > Remove reported issue from th' browser’ s console.< / p >
< p > Check fer unnecessary whitespace an' correct indent'n o' yer result'n HTML.< / p >
< p > Be compat'ble t' IE11, at least fer main functionality, this means:< / p >
< ul >
< li > test 'n IE11< / li >
< li > check caniuse.com< / li >
< li > don’ t use JavaScript arrow funct'ns< / li >
< li > don’ t use JavaScript template literals< / li >
< li > don’ t use other fancy JavaScript ES5/6 stuff< / li >
< / ul >
< h2 id = "conventional-commits" > Conventional Commits< / h2 >
2023-10-28 20:28:18 +00:00
< p > Write commit messages 'n th' < a href = "https://www.conventionalcommits.org/en/v1.0.0/" target = "_blank" > conventional commit< / a > format.< / p >
2023-01-28 13:49:11 +00:00
< p > Follow'n be an impomplete list o' some o' th' used conventional commit types. Be creative.< / p >
< table >
< thead >
< tr >
< th > Common< / th >
< th > Feature< / th >
< th > Structure< / th >
< th > Shorrrtcodes< / 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 > shorrrtcodes< / td >
< td > i18n< / td >
< td > scrollbar< / td >
< td > expand< / td >
< / tr >
< tr >
< td > theme< / td >
< td > mobile< / td >
< td > nav< / td >
< td > ay'con< / 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 >
2023-05-14 21:06:26 +00:00
< td > openapi< / td >
2023-01-28 13:49:11 +00:00
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td > < / td >
2023-05-14 21:06:26 +00:00
< td > piratify< / td >
2023-01-28 13:49:11 +00:00
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td > < / td >
2023-05-14 21:06:26 +00:00
< td > siteparam< / td >
2023-01-28 13:49:11 +00:00
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td > < / td >
< td > tabs< / td >
< / tr >
< / tbody >
< / table >
< footer class = "footline" >
< / footer >
< / article >
2023-05-17 22:13:41 +00:00
2023-01-28 13:49:11 +00:00
< / div >
< / main >
< / div >
2023-10-28 22:03:53 +00:00
< script src = "../../../js/clipboard.min.js?1698530629" defer > < / script >
< script src = "../../../js/perfect-scrollbar.min.js?1698530629" defer > < / script >
< script src = "../../../js/theme.js?1698530629" defer > < / script >
2023-01-28 13:49:11 +00:00
< / body >
< / html >
