SeichiAssist
SeichiAssist copied to clipboard
ドキュメントを整備する
SeichiAssist は OSS としてプレイヤーや外部の人間にも開発を促したいが、コード自体や、コード内に存在しているコメントアウトだけでは仕様を完全に網羅するのは難しいので仕様書を別途で用意することで少しでも開発への参加のハードルを下げたり、開発体験を向上させる
仕様書というよりかはドキュメントに近い
「 https://github.com/GiganticMinecraft/SeichiAssist-Assist これは?」
これに追記していく形でもいいのでは?(てかこれがまさにそれ?)
そのリポジトリを更新して言ってもいい気はしますが、そのリポジトリはどちらかというとScalaを詳しく解説しようとしてる気がするのでこのリポジトリのWikiを更新していったほうが楽な気がします
SeichiAssist が難しいのもそうだけど同時に Scala という言語は関数型とオブジェクト指向のマルチパラダイムプログラミング言語というのもあり基本的に難易度が高いので、Scala の基本的な説明も加えたいお気持ち (For-Comprehensions なんか、りとさんに教えてもらうまで理解できなかった概念)
このリポジトリのWikiを更新していったほうが楽な気がします
私としては、WikiはPull RequestやIssueとの親和性が高くないので使いたくないです。
Member (GiganticMinecraft) 以外の編集ができないのもある
そのリポジトリを更新して言ってもいい気はしますが、そのリポジトリはどちらかというとScalaを詳しく解説しようとしてる気がする
これに関してですが、もともとは Scala の基本的な部分と SeichiAssist の設計指針までを包括するドキュメントにするつもりでした(全然更新に時間割けていませんが…)。
バージョン管理や issue 管理などの観点から、僕も開発者向けドキュメントは当リポジトリ内か SeichiAssist-Assist に集約するのが良いと考えています。
こっちを更新していくのが丸いんですかね