How to よくある疑問へのクイックリファレンス

* より新しいオリジナル(英語)へのリンク

ofBook openFrameworksのガイド集

貢献ドキュメンテーションの改善方法

ドキュメンテーションは、openFrameworksの本体と同じようにユーザーによって書かれています。

間違った情報を見つけた時は?

もし確証が無い場合は、まずフォーラムで確認してください。もしドキュメントを訂正したい場合は、GithubのリポジトリーをForkし、分離したブランチを作成してPull Requestを送ってください。もしGitに詳しくない場合は、友達に助けてもらってください。

現在のドキュメントの改善に貢献したい時は?

すばらしい! 私たちは以下のドキュメントを改善していきたいと考えています。

  • このサンプルのように、exampleフォルダ内のそれぞれのサンプルにReadmeを追加したい。
  • モジュール・ドキュメントを完成させたい。全てのモジュールは、ドキュメントのページで "Module Documentation"をクリックすると、モジュール・ドキュメントが表示されます。もし重要な要素が抜け落ちていたり、きちんと説明されていないと感じるなら、openFrameworksのWebサイトのリポジトリにPull Requestしてください。
  • openFrameworksのWebサイトのリポジトリにある、documentationフォルダ内にあるのクラスのドキュメントを完成させたい。
  • openFrameworksのリポジトリのソースコード内に書かれている、関数のドキュメントを完成させたい。