ALIS APIドキュメントの改善に参加した話

ALIS APIドキュメントを見ていたら、誤記っぽいものを見つけたので、報告し、修正が取り入れられました。

私が見つけたもの

tagが、integer(整数値)となっていたので、string(文字列)に修正提案しました。

手順

ALIS APIドキュメントの元データは、github上で管理されています。なので、githubで修正を提案します。

githubとは

githubは、プログラムのコードなどを管理するウェブサービスです。単にコードを管理するだけではありません。上の画像で分かるように、誰が／いつ／どのようなコメント・コードを書いたか、といった記録がつけられます。

コードを改善したい人は、自分が書いたコード・なぜそのコードを書いたか、などを書き込みます。そうするとコードを管理している人が確認して、取り込んだり、書いた人に追加の説明を要求したり、といったことができます。

自分一人でコードを書いている場合でも、記録が残るので便利です。しかし、それ以上に、何人かでコードを書いている場合に重宝します。オープンソースで開発している場合には、こういったコード管理機能がほぼ必須だと思われます。(github以外にも似たウェブサービスがあります。)

githubは良く分からん、という人は

ALIS APIドキュメントの改善があるけど、githubは良く分からん、という人は、この記事にコメントいただければ、私からgithubで提案してみます。

※その他の記事もごらんください。