開發須知.md

TK4 開發須知

首先感謝您加入 TK4 開發團隊，總裁小徹希望你可以閱讀以下專案開發規範，以利往後的開發。

安裝虛擬環境

在運行專案之前，需要先建立虛擬環境，並注意以下幾點：

• 安裝 requirements.txt 內的套件
• 運行 Python 版本: 3.10.7

命名

在本專案，命名的部分都有明確的規範：

檔案

採用 大駝峰式命名法，舉例如下：

FunnyCommands.py

一般變數 / 方法

採用 lowercase_separated_by_underscores，舉例如下：

# 根據 send_time.hour 回傳 night_data 內的回應資料
def night_response(send_time):
    hour = send_time.hour
    if 1 <= hour and hour < 6:
        return night_data['h1-6'][randint(0, 2)]
    elif 6 <= hour and hour < 12:
        return night_data['h6-12'][randint(0, 2)]
    ...

常數

採用 CAPITALIZED_WITH_UNDERSCORES 命名方式。假設該常數屬於 channel id，然後該頻道的功用是取得身分組，那麼可以這樣寫：

CHANNEL_ID_GET_ROLES = channel_id["領取身分組"]

環境變數

請直接使用 .env 檔裡面的名稱，舉例如下：

DISCORD_BOT_TOKEN = config.get("DISCORD_BOT_TOKEN")