これはrt-botを開発する上でやって欲しいことを求めたものです。
なるべく以下のような感じにすると嬉しいです。
# 新しく何かを作った場合
new: 内容
# 更新をした場合
update: 内容
# バグ修正をした場合
fix: 内容
# 何か変更をした場合
change: 内容コミットメッセージの最初のタグ(fixやnewなど)の後に[]を使って以下のように注釈を付け加えるとより嬉しいです。
# 文字列を変えただけの場合
change[text]: 内容
# ドキュメンテーションを変えただけの場合
change[doc]: 内容PEP8で文字数は90文字より少ない文字数にして欲しいです。
ファイルの最初には以下のように# RT - ファイルにあるものの名前のようにつけて改行をして欲しいです。
# RT - Help Command
...importは以下のように巨大なもので分けて行にある文字数の多さで並び替えをして欲しいです。
ですがtypingを入れる場合はそのインポートだけは一番上でTYPE_CHECKINGは一番下がいいです。
from typing import TYPE_CHECKING
from discord.ext import commands
import discord
from reprypt import decrypt
from ujson import loads
from .constants import DEFAULT
if TYPE_CHECKING:
...クラスや関数などでインデントがない場所にあるものは以下のように二行ずつにして欲しいです。
def test(...) -> ...:
...
class Wow:
def huga(self, ...) -> ...:
...
def test(self, ...) -> ...:
...色々な場所で使われるような関数には軽いドキュメンテーションとアノテーションをつけて欲しいです。
内部的に使われるものには_を最初につけて関数のちょっとした説明を#のコメントで示して欲しいです。
(アノテーションは不要です。)
from typing import Optional
def encode(text: str) -> Optional[str]:
"これは渡された文字列をエンコードする関数です。"
...
def _plus(text):
# これは渡されたエンコードされた文字列を拡張するものです。
...外部的に使われるような変数には型アノテーションをなるべくつけるようにしてください。
もし汚くなるようでしたらクラス直下にアノテーションをつけた変数を列挙しましょう。
DiscordのBotのコマンドの場合はアノテーションを書かなくても良いです。
rtは現在nextcordで開発されています。さらにいくつかの機能を拡張して使いやすくしています。 そのためいくつか本家discord.pyとは違う点があるので注意してください。
commands.commandの引数にextrasをつけることができます。
{
"headding":{"ja":"...", "en":"..."},
"parent":"ServerPanel"
}extrasの引数はこのようにheaddingとparentで構成されています。 headdingには日本語と英語でコマンドの簡潔な説明を、parentにはRTのヘルプで出すカテゴリを英語で入れてください。
Context.sendのcontent引数に{"ja":"...", "en":"..."}の形式で辞書を入れると、 自動で言語を判別してその言語にあった内容が送信されるようになります。 現時点で全て対応済みですが、新しくsendする場合は作ると良いでしょう。
Cogはon_readyが呼ばれてからロードされるので、Cog内ではon_readyの代わりとしてinit関数を使うかon_full_readyが使えます。 on_full_readyイベントはrtが全てのCogを読み込んだ後に呼ばれます。