Abstract

用來整理學習資源之 Repo.，包含網站上好文、論文等之讀書心得。

Todo

Development

• auto-gen-contents module

  • Descriptions

    • 能自動化依據 reading 目錄下的結構、.md 生成目錄，於 root directory 內的 README 當中供讀者輕鬆找到想找的文章

  • Requirments

    • 自動生成目錄
    • Git hooks - pre-commit phase 自動執行
• Contents generator optimize and new feature
  • 依照筆記量釋出不同顏色標籤
    • 偵測筆記較少的 md 標記為`尚未完成
  • 架構優化
  • Keyword 自動生成
    • 從文本當中超連結自動爬入字串，以較為泛用的方式前處理並提取關鍵詞
  • auto-gen module 建置於 pre-commit phase 自動執行產生目錄

Operations

• 撰寫 CONTRIBUTING
• 撰寫單元測試

Pre-commit 環境建置

# easy install by pip
$ pip install pre-commit

# install pre-commit framework to git hooks
$ pre-commit install

# Uninstall if you need
$ pre-commit uninstall

Branch

分支操作使用自定義的形式，大部分規則與一般版控分支 common practice 雷同，規則如下:

Branch name	Descriptions
master	stable version, include reading and ./bin done.
read	brand of updating feature reading, seam like dev branch in common practice.
{some feature develop name}	branch for develop feature.

Contents

• reading
  1. vscode.md

  • Data science

    1. Data science… without any data.md
    2. 資料科學五大 Q&A：如何成為資料科學家？資料科學產業的未來？.md

  • Data scientist roadmap

    1. Data scientist roadmap.md

  • Design Pattern

    • Domain-Driven Design
      1. 1_初探.md

  • Docker

    1. 3_Docker 基本運作.md
    2. Docker compose.md
    3. Docker入門.md

  • Git

    1. CICD初探.md
    2. 版本號的基本常識.md
    • Github pages
      1. Github pages - 輕鬆架設靜態網頁.md

  • Linux

    1. 鳥哥 Shell script.md

  • Programing

    1. Locust preformance testing tool.md
    2. 何謂DevOps.md

  • Python

    1. Anaconda.md
    2. Flask.md
    3. 如何用 Python 撰寫 APP.md
    4. 如何處理比 memory 更大的資料.md
    5. 親自動手寫一個 Python libary.md
    • Basic
      1. cmd python 預設使用 python3.md
      2. Decorator.md
      3. PIP.md
      4. Python 在 DevOps 中的應用.md
    • Class
      1. Meta class.md
      2. new and init.md
    • High quality code
      1. Code quality.md
      2. Common practice of famous project.md
      3. PEP8.md
      • Coding style
        1. black.md
        2. Coding style.md
        3. pylint.md
        • pre-commit
          1. 1_調研 pre-commit.md
          2. 2_pre-commit.md
          3. 3_pre-commit 三度調研.md
      • Docs
        1. pydocstyle.md
      • Testing
        1. Flaky test.md
        2. Pytest Coverage.md
        3. Pytest doctest.md
        4. Pytest notebook.md
        5. Pytest 測試實戰.md
        6. 初探Tox.md
    • Pyproject
      1. How to setup.py.md