寄稿要領

frc-docsプロジェクトの寄稿要領へようこそ。reStructuredTextで書くことに不慣れな場合は、 こちら をご覧ください。

重要

提供された文書や画像に関するすべての権利は FIRST® が保有します。記事やアップデートのクレジットは、 GitHubのコミット履歴 で確認することができます。

ミッション・ステートメント

WPILibのミッションは、 FIRST のロボッティクスチームがハードウェアの細部にこだわるのではなく、ゲームに特化したソフトウェアの開発に集中できるようにすること、つまり「床を上げ、天井を下げない」ということです。プログラミングの知識や指導者の経験が少ないチームでも、可能な限り成功できるように、また、より高度なプログラミング能力を持つチームの能力を妨げないように取り組んでいます。Kit of Parts の制御系コンポーネントをライブラリで直接サポートしています。また、FRCでのサポートされている各言語（Java、C++、NI LabVIEW）の主要な機能が同等であるように努め、特定のプログラミング言語を選択したことでチームが不利にならないようにします。

これらのドキュメントは、すべての FIRST Robotics Competition のチームに学びの場を提供しています。プロジェクトへの寄稿は、これらの基本原則に従わなければなりません。

  • コミュニティー主導のドキュメント：ドキュメントの出所は公開でホストされ、コミュニティーが寄稿することができます。

  • 構造化された・整った・綺麗なドキュメント。ドキュメントはソースとリリースの両方でも、きれいで読みやすいものであるべきです。

  • 関連性を保つ：ドキュメントは FIRST Robotics Competition に注目すべきです。

スタイルについては、 スタイルガイド をご覧ください。

リリースプロセス

frc-docsはメインサイト /stable/ と開発サイト /latest/ を別々に処理するための特化したリリースプロセスを使います。プロセスの詳しくは以下の通りです。

シーズン中：

  • main ブランチへのコミット

    • ウェブサイトで /stable/ と /latest/ が更新されます

シーズン終了：

  • レポジトリーは、アーカイブのため、ゲーム年でタグされます。

オフシーズン：

  • stable ブランチは、シーズンの最後のコミットで保持されます

  • main ブランチへのコミット

    • ドキュメントサイトの /latest/ のみが更新されます。

PRの作成方法

PRはGitHubでの frc-docs レポジトリに作成すべきです。stable ブランチ ではなく、main ブランチを指す必要があります。

新しいコンテンツの作成

frc-docs プロジェクトへの寄稿者になってくださりありがとうございます。寄稿する前に知っておくべきことがいくつかあります。

記事の配置は？

新しい記事の位置は、かなり議論になるところです。すでにある主題のカテゴリーにうまく当てはまる独立した記事は、言及された主題のカテゴリーに置かれるべきです（例：シミュレーションに関するドキュメントは、シミュレーションのセクションに置かれるべきです）。しかし、記事が別々のセクションを組み合わせたり、参照したりする場合は、かなり複雑になることがあります。このような場合、PRを作成する前に、寄稿者がレポジトリでIssueを作成し、議論を行うことをお勧めします。

注釈

全ての新しい記事は、レポジトリにマージされる前に、WPILibのチームメンバーに審査が行われます。記事は、FIRST での公式サポートされているソフトウエアとハードウエアに集中する必要があります。非公式のセンサーやソフトウエアライブラリーについてのドキュメントは 受け取れません 。審査には少し時間がかかりますので、お待ち下さい。

セクションの配置は？

セクションの配置は、大量のコンテンツが含まれるため、かなり難しいです。寄稿者がセクションを作成や編集をする前に、 Issue を作成し、コミュニティーフィードバックを収集することをお勧めします。