-
Notifications
You must be signed in to change notification settings - Fork 0
scikit-ika/scikit-ika.github.io
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html> <html lang="en"> <head prefix="og: http://ogp.me/ns#"> <meta charset="utf-8"> <title>Contributing | scikit-ika</title> <meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1"> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Canonical links --> <link rel="canonical" href="https://scikit-ika.github.io/docs/contributing.html"> <!-- Alternative links --> <link rel="alternative" hreflang="en" href="https://scikit-ika.github.io/docs/contributing"> <link rel="alternative" hreflang="zh-tw" href="https://scikit-ika.github.io/zh-tw/docs/contributing"> <link rel="alternative" hreflang="zh-cn" href="https://scikit-ika.github.io/zh-cn/docs/contributing"> <link rel="alternative" hreflang="ru" href="https://scikit-ika.github.io/ru/docs/contributing"> <link rel="alternative" hreflang="ko" href="https://scikit-ika.github.io/ko/docs/contributing"> <link rel="alternative" hreflang="pt-br" href="https://scikit-ika.github.io/pt-br/docs/contributing"> <link rel="alternative" hreflang="th" href="https://scikit-ika.github.io/th/docs/contributing"> <!-- Icon --> <link rel="apple-touch-icon" sizes="57x57" href="/icon/apple-touch-icon-57x57.png"> <link rel="apple-touch-icon" sizes="114x114" href="/icon/apple-touch-icon-114x114.png"> <link rel="apple-touch-icon" sizes="72x72" href="/icon/apple-touch-icon-72x72.png"> <link rel="apple-touch-icon" sizes="144x144" href="/icon/apple-touch-icon-144x144.png"> <link rel="apple-touch-icon" sizes="60x60" href="/icon/apple-touch-icon-60x60.png"> <link rel="apple-touch-icon" sizes="120x120" href="/icon/apple-touch-icon-120x120.png"> <link rel="apple-touch-icon" sizes="76x76" href="/icon/apple-touch-icon-76x76.png"> <link rel="apple-touch-icon" sizes="152x152" href="/icon/apple-touch-icon-152x152.png"> <link rel="icon" type="image/png" href="/icon/favicon-196x196.png" sizes="196x196"> <link rel="icon" type="image/png" href="/icon/favicon-160x160.png" sizes="160x160"> <link rel="icon" type="image/png" href="/icon/favicon-96x96.png" sizes="96x96"> <link rel="icon" type="image/png" href="/icon/favicon-16x16.png" sizes="16x16"> <link rel="icon" type="image/png" href="/icon/favicon-32x32.png" sizes="32x32"> <meta name="msapplication-TileColor" content="#2f83cd"> <meta name="msapplication-TileImage" content="/icon/mstile-144x144.png"> <!-- CSS --> <!-- build:css build/css/navy.css --> <link rel="stylesheet" href="/css/navy.css"> <!-- endbuild --> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/typeface-lato@0.0.75/index.min.css"> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/font-awesome@4.3.0/css/font-awesome.min.css"> <link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"> <!-- RSS --> <link rel="alternate" href="/atom.xml" title="scikit-ika" type="application/atom+xml"> <!-- Open Graph --> <meta name="description" content="We welcome you to join the development of Hexo. 🤗 DevelopmentWe welcome you to join the development of Hexo. This document will help you through the process. Before You StartPlease follow the coding"> <meta property="og:type" content="website"> <meta property="og:title" content="Contributing"> <meta property="og:url" content="https://scikit-ika.github.io/docs/contributing"> <meta property="og:site_name" content="scikit-ika"> <meta property="og:description" content="We welcome you to join the development of Hexo. 🤗 DevelopmentWe welcome you to join the development of Hexo. This document will help you through the process. Before You StartPlease follow the coding"> <meta property="og:locale" content="en_US"> <meta property="article:published_time" content="2020-03-03T19:07:09.971Z"> <meta property="article:modified_time" content="2020-03-03T19:07:09.971Z"> <meta property="article:author" content="Team scikit-ika"> <meta name="twitter:card" content="summary"> <meta name="twitter:site" content="scikit-ika"> <meta property="fb:admins" content="100000247608790"> <!-- Google Analytics --> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-48498357-3', 'auto'); ga('send', 'pageview'); </script> <script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script> <script> (adsbygoogle = window.adsbygoogle || []).push({ google_ad_client: "ca-pub-6482217598104186", enable_page_level_ads: true }); </script> </head> <body> <div id="container"> <header id="header" class="wrapper"> <div id="header-inner" class="inner"> <h1 id="logo-wrap"> <a href="/" id="logo">Hexo</a> </h1> <nav id="main-nav"> <a href="/scikit-ika/" class="main-nav-link">Docs</a><a href="/news/" class="main-nav-link">News</a><a href="/about/" class="main-nav-link">About</a> <a target="_blank" href="https://github.com/scikit-ika/scikit-ika" rel="external nofollow noreferrer noopener" class="main-nav-link"><i class="fa fa-github-alt"></i></a> <div id="search-input-wrap"> <div id="search-input-icon"> <i class="fa fa-search"></i> </div> <input type="search" id="search-input" placeholder="Search..."> </div> </nav> <a id="mobile-nav-toggle"> <span class="mobile-nav-toggle-bar"></span> <span class="mobile-nav-toggle-bar"></span> <span class="mobile-nav-toggle-bar"></span> </a> </div> </header> <div id="content-wrap"> <div id="content" class="wrapper"> <div id="content-inner"> <article class="article-container" itemscope itemtype="http://schema.org/Article"> <div class="article-inner"> <div class="article"> <div class="inner"> <header class="article-header"> <h1 class="article-title" itemprop="name">Contributing</h1> <a target="_blank" href="https://github.com/scikit-ika/scikit-ika.github.io/edit/master/source/docs/contributing.md" rel="external nofollow noreferrer noopener" class="article-edit-link" title="Improve this doc"><i class="fa fa-pencil"></i></a> </header> <div class="article-content" itemprop="articleBody"> <p>We welcome you to join the development of Hexo. 🤗</p> <h2 id="Development" class="article-heading"><a href="#Development" class="headerlink" title="Development"></a>Development<a class="article-anchor" href="#Development" aria-hidden="true"></a></h2><p>We welcome you to join the development of Hexo. This document will help you through the process.</p> <h3 id="Before-You-Start" class="article-heading"><a href="#Before-You-Start" class="headerlink" title="Before You Start"></a>Before You Start<a class="article-anchor" href="#Before-You-Start" aria-hidden="true"></a></h3><p>Please follow the coding style:</p> <ul> <li>Follow <a target="_blank" href="https://google.github.io/styleguide/jsguide.html" rel="external nofollow noreferrer noopener">Google JavaScript Style Guide</a>.</li> <li>Use soft-tabs with a two space indent.</li> <li>Don’t put commas first.</li> </ul> <h3 id="Workflow" class="article-heading"><a href="#Workflow" class="headerlink" title="Workflow"></a>Workflow<a class="article-anchor" href="#Workflow" aria-hidden="true"></a></h3><ol> <li><p>Fork <a target="_blank" href="https://github.com/hexojs/hexo" rel="external nofollow noreferrer noopener">hexojs/hexo</a>.</p> </li> <li><p>Clone the repository to your computer and install dependencies.</p> <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">$ git clone https://github.com/<username>/hexo.git</span><br><span class="line">$ cd hexo</span><br><span class="line">$ npm install</span><br><span class="line">$ git submodule update --init</span><br></pre></td></tr></table></figure> </li> <li><p>Create a feature branch.</p> <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">$ git checkout -b new_feature</span><br></pre></td></tr></table></figure> </li> <li><p>Start hacking.</p> </li> <li><p>Push the branch:</p> <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">$ git push origin new_feature</span><br></pre></td></tr></table></figure> </li> <li><p>Create a pull request and describe the change.</p> </li> </ol> <h3 id="Notice" class="article-heading"><a href="#Notice" class="headerlink" title="Notice"></a>Notice<a class="article-anchor" href="#Notice" aria-hidden="true"></a></h3><ul> <li><p>Don’t modify version number in <code>package.json</code>.</p> </li> <li><p>Your pull request will only get merged when tests passed. Don’t forget to run tests before submission.</p> <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">$ npm test</span><br></pre></td></tr></table></figure> </li> </ul> <h2 id="Updating-official-plugins" class="article-heading"><a href="#Updating-official-plugins" class="headerlink" title="Updating official-plugins"></a>Updating official-plugins<a class="article-anchor" href="#Updating-official-plugins" aria-hidden="true"></a></h2><p>Also, we welcome PR or issue to <a target="_blank" href="https://github.com/hexojs" rel="external nofollow noreferrer noopener">official-plugins</a>. 🤗</p> <h2 id="Updating-Documentation" class="article-heading"><a href="#Updating-Documentation" class="headerlink" title="Updating Documentation"></a>Updating Documentation<a class="article-anchor" href="#Updating-Documentation" aria-hidden="true"></a></h2><p>The Hexo documentation is open source and you can find the source code on <a target="_blank" href="https://github.com/hexojs/site" rel="external nofollow noreferrer noopener">hexojs/site</a>.</p> <h3 id="Workflow-1" class="article-heading"><a href="#Workflow-1" class="headerlink" title="Workflow"></a>Workflow<a class="article-anchor" href="#Workflow-1" aria-hidden="true"></a></h3><ol> <li><p>Fork <a target="_blank" href="https://github.com/hexojs/site" rel="external nofollow noreferrer noopener">hexojs/site</a></p> </li> <li><p>Clone the repository to your computer and install dependencies.</p> <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">$ git clone https://github.com/<username>/site.git</span><br><span class="line">$ cd site</span><br><span class="line">$ npm install</span><br></pre></td></tr></table></figure> </li> <li><p>Start editing the documentation. You can start the server for live previewing.</p> <figure class="highlight plain"><table><tr><td class="code"><pre><span class="line">$ hexo server</span><br></pre></td></tr></table></figure> </li> <li><p>Push the branch.</p> </li> <li><p>Create a pull request and describe the change.</p> </li> </ol> <h3 id="Translating" class="article-heading"><a href="#Translating" class="headerlink" title="Translating"></a>Translating<a class="article-anchor" href="#Translating" aria-hidden="true"></a></h3><ol> <li>Add a new language folder in <code>source</code> folder. (All lower case)</li> <li>Copy Markdown and template files in <code>source</code> folder to the new language folder.</li> <li>Add the new language to <code>source/_data/language.yml</code>.</li> <li>Copy <code>en.yml</code> in <code>themes/navy/languages</code> and rename to the language name (all lower case).</li> </ol> <h2 id="Reporting-Issues" class="article-heading"><a href="#Reporting-Issues" class="headerlink" title="Reporting Issues"></a>Reporting Issues<a class="article-anchor" href="#Reporting-Issues" aria-hidden="true"></a></h2><p>When you encounter some problems when using Hexo, you can find the solutions in <a href="troubleshooting.html">Troubleshooting</a> or ask me on <a target="_blank" href="https://github.com/hexojs/hexo/issues" rel="external nofollow noreferrer noopener">GitHub</a> or <a target="_blank" href="https://groups.google.com/group/hexo" rel="external nofollow noreferrer noopener">Google Group</a>. If you can’t find the answer, please report it on GitHub.</p> <ol> <li>Represent the problem in <a href="commands.html#Debug_mode">debug mode</a>.</li> <li>Run <code>hexo version</code> and check the version info. </li> <li>Post both debug message and version info on GitHub.</li> </ol> </div> <footer class="article-footer"> <time class="article-footer-updated" datetime="2020-03-03T19:07:09.971Z" itemprop="dateModified">Last updated: 2020-03-03</time> <a href="troubleshooting.html" class="article-footer-prev" title="Troubleshooting"><i class="fa fa-chevron-left"></i><span>Prev</span></a> </footer> </div> </div> <aside id="article-toc" role="navigation"> <div id="article-toc-inner"> <strong class="sidebar-title">Contents</strong> <ol class="toc"><li class="toc-item toc-level-2"><a class="toc-link" href="#Development"><span class="toc-text">Development</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#Before-You-Start"><span class="toc-text">Before You Start</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Workflow"><span class="toc-text">Workflow</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Notice"><span class="toc-text">Notice</span></a></li></ol></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Updating-official-plugins"><span class="toc-text">Updating official-plugins</span></a></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Updating-Documentation"><span class="toc-text">Updating Documentation</span></a><ol class="toc-child"><li class="toc-item toc-level-3"><a class="toc-link" href="#Workflow-1"><span class="toc-text">Workflow</span></a></li><li class="toc-item toc-level-3"><a class="toc-link" href="#Translating"><span class="toc-text">Translating</span></a></li></ol></li><li class="toc-item toc-level-2"><a class="toc-link" href="#Reporting-Issues"><span class="toc-text">Reporting Issues</span></a></li></ol> <a href="#" id="article-toc-top">Back to Top</a> </div> </aside> </div> </article> <aside id="sidebar" role="navigation"> <div class="inner"> <strong class="sidebar-title">Getting Started</strong><a href="index.html" class="sidebar-link">Overview</a><a href="setup.html" class="sidebar-link">Setup</a><a href="configuration.html" class="sidebar-link">Configuration</a><a href="commands.html" class="sidebar-link">Commands</a><a href="migration.html" class="sidebar-link">Migration</a><strong class="sidebar-title">Basic Usage</strong><a href="writing.html" class="sidebar-link">Writing</a><a href="front-matter.html" class="sidebar-link">Front-matter</a><a href="tag-plugins.html" class="sidebar-link">Tag Plugins</a><a href="asset-folders.html" class="sidebar-link">Asset Folders</a><a href="data-files.html" class="sidebar-link">Data Files</a><a href="server.html" class="sidebar-link">Server</a><a href="generating.html" class="sidebar-link">Generating</a><strong class="sidebar-title">Deployment</strong><a href="github-pages.html" class="sidebar-link">GitHub Pages</a><a href="gitlab-pages.html" class="sidebar-link">GitLab Pages</a><a href="one-command-deployment.html" class="sidebar-link">One-Command Deployment</a><strong class="sidebar-title">Customization</strong><a href="permalinks.html" class="sidebar-link">Permalinks</a><a href="themes.html" class="sidebar-link">Themes</a><a href="templates.html" class="sidebar-link">Templates</a><a href="variables.html" class="sidebar-link">Variables</a><a href="helpers.html" class="sidebar-link">Helpers</a><a href="internationalization.html" class="sidebar-link">Internationalization (i18n)</a><a href="plugins.html" class="sidebar-link">Plugins</a><strong class="sidebar-title">Miscellaneous</strong><a href="troubleshooting.html" class="sidebar-link">Troubleshooting</a><a href="contributing.html" class="sidebar-link current">Contributing</a> </div> </aside> </div> </div> </div> <footer id="footer" class="wrapper"> <div class="inner"> <div id="footer-copyright"> © 2022 <a href="https://github.com/scikit-ika/scikit-ika/graphs/contributors" rel="external nofollow noreferrer" target="_blank">Team scikit-ika</a><br> Documentation licensed under <a href="https://github.com/scikit-ika/scikit-ika/blob/master/LICENSE" rel="external nofollow noreferrer" target="_blank">BSD 3-Clause</a>. </div> <div id="footer-links"> <a href="https://github.com/scikit-ika/scikit-ika" rel="external nofollow noreferrer" class="footer-link" target="_blank"><i class="fa fa-github-alt"></i></a> </div> </div> </footer> </div> <div id="mobile-nav-dimmer"></div> <nav id="mobile-nav"> <div id="mobile-nav-inner"> <ul id="mobile-nav-list"> <a href="/scikit-ika/" class="mobile-nav-link">Docs</a><a href="/news/" class="mobile-nav-link">News</a><a href="/about/" class="mobile-nav-link">About</a> <li class="mobile-nav-item"> <a href="https://github.com/scikit-ika/scikit-ika" class="mobile-nav-link" rel="external" target="_blank">GitHub</a> </li> </ul> <strong class="mobile-nav-title">Getting Started</strong><a href="index.html" class="mobile-nav-link">Overview</a><a href="setup.html" class="mobile-nav-link">Setup</a><a href="configuration.html" class="mobile-nav-link">Configuration</a><a href="commands.html" class="mobile-nav-link">Commands</a><a href="migration.html" class="mobile-nav-link">Migration</a><strong class="mobile-nav-title">Basic Usage</strong><a href="writing.html" class="mobile-nav-link">Writing</a><a href="front-matter.html" class="mobile-nav-link">Front-matter</a><a href="tag-plugins.html" class="mobile-nav-link">Tag Plugins</a><a href="asset-folders.html" class="mobile-nav-link">Asset Folders</a><a href="data-files.html" class="mobile-nav-link">Data Files</a><a href="server.html" class="mobile-nav-link">Server</a><a href="generating.html" class="mobile-nav-link">Generating</a><strong class="mobile-nav-title">Deployment</strong><a href="github-pages.html" class="mobile-nav-link">GitHub Pages</a><a href="gitlab-pages.html" class="mobile-nav-link">GitLab Pages</a><a href="one-command-deployment.html" class="mobile-nav-link">One-Command Deployment</a><strong class="mobile-nav-title">Customization</strong><a href="permalinks.html" class="mobile-nav-link">Permalinks</a><a href="themes.html" class="mobile-nav-link">Themes</a><a href="templates.html" class="mobile-nav-link">Templates</a><a href="variables.html" class="mobile-nav-link">Variables</a><a href="helpers.html" class="mobile-nav-link">Helpers</a><a href="internationalization.html" class="mobile-nav-link">Internationalization (i18n)</a><a href="plugins.html" class="mobile-nav-link">Plugins</a><strong class="mobile-nav-title">Miscellaneous</strong><a href="troubleshooting.html" class="mobile-nav-link">Troubleshooting</a><a href="contributing.html" class="mobile-nav-link current">Contributing</a> </div> </nav> <!-- Scripts --> <!-- Cookie --> <script src="https://cdn.jsdelivr.net/npm/js-cookie@2/src/js.cookie.min.js"></script> <!-- build:js build/js/main.js --> <script src="/js/lang_select.js"></script> <script src="/js/toc.js"></script> <script src="/js/mobile_nav.js"></script> <!-- endbuild --> <!-- Algolia --> <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script> <script type="text/javascript"> document.getElementById('search-input-wrap').classList.add('off'); docsearch({ apiKey: 'c3d5d4c995b5e0c2ffb5623900279a66', indexName: 'hexo', inputSelector: '#search-input' }); </script> </body> </html>
About
scikit-ika's homepage
Contributing
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published