プログラムの書き方について

[renoisme]

UniBotのソースコードを見ましたが、コードが複雑かつ書き方がバラバラだったのでこのIssuesを立てます。

１ Readme.md にいて

現在のReadme.mdは英語で記載されていますが、UniBotは日本人向けのBOTであるため、日本語での記載がより適切であると考えます。

３ コードの書き方に関する規定の導入

UniBotのソースコードには一貫性が欠如しており、コードの書き方に関する規定が明確に定義されていません。統一された書き方の導入は、コードの保守性や拡張性を向上させるために重要です。
Uniのソースコードは一貫性がなく、コードの書き方に関する規定を定義する必要があると思います。

また、このような シャードから情報を取得する書き方は大規模なBOTであれば処理速度やシャーディングとしては良いと思いますが、それに至ってない状態でこの書き方をしてしまうと可読性の低下や思わぬバグを発生させる原因になると考えます。

また、prettierrc などで書式の設定を行うことで可読性が向上すると思います。

４ プログラムの構成について

このように clientオブジェクトに設定などを入れていますが、これについてReadmeに書いておいた方が良いと思います。

また、下のように略した書き方は可読性の低下や思わぬバグ...略

• interactionをiと置いている
• 略している

client.conf = config;
client.func = functions;

↓↓↓↓↓↓

client.config = config;
client.function = functions;

[yuito-it]

今までの指摘に対しての回答

1. Readmeに関して
   これに関しては、ほぼぼくが書いてないです。
   現役のドワンゴエンジニアさんがアドバイスくれてそれを一部改変した内容をアドバイス通り英語で書いてます。

2. ソースコードの一貫性の欠如
   ソースコードの一貫性の欠如は承知しました。こちらに関しては規定を早急に用意します。

3. プログラムの構成について

Clientなどに設定などを入れていますが、これについてReadmeに書いておいた方が良いと思います。
これに関しては承知いたしました。
また、下のように略した書き方は可読性の低下や思わぬバグ...略
これに関しては、ドワンゴの現役エンジニアさんにコードレビューしてもらった時に、何も言われず帰ってきた&わかればいいだそうです()これ以上の理由があれば書き直しますが...

最後に

このBotはもともと @yuito-it の個人開発であり、それを @UniPro-tech に移管しています。なので、まだ個人開発者の荒っぽいコードが半分残っているのは確かです。
なるべく早急に対応しますので、今しばらくお待ちください。