注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。
15 - パイプラインにREADMEファイルを追加してドキュメント化する
📖 タスクの概要
データフローグラフをドキュメントとして追加しました。これで passengers リポジトリに README ファイルを追加し、さらなる詳細を追加します。
🔨 タスクの説明
passengers_logicコードリポジトリを開きます。- ブランチ (
Masterから) をyourName/feature/add_readmeという名前で新しく作成します。 - リポジトリの左上のブランチ名のすぐ下にある ⊕ ボタンをクリックし、新規ファイル を選択します。
- 新規ファイル ウィンドウで、リポジトリのファイル構造のルートに達するまで左にスクロールします。そして、ルートフォルダーに新しいファイルを作成したいことを示すために、
/をクリックします。下図のように表示されます。
-
ファイル名を
README.mdにして、ウィンドウの右下の青い 作成 ボタンをクリックします。 -
新しいファイルを開き、以下のブロックをエディタウィンドウに貼り付けます。
## Passengers Pipeline #### Ownership * Project team: Aviation Data Development * Project owner: yourName@yourOrganization.com #### Overview This pipeline takes raw data ingested from the Passengers datasource and: 1. Parses raw CSVs and JSONs into dataframes 2. Normalizes column names and data types across all raw datasets -
コードをコミットします (例: “feature: add readme”)。
-
PRプロセスを完了して、ブランチを
Masterにマージします。CI チェックが通るまで待ってからマージを完了する必要があります。