12 - ソースリポジトリにREADMEファイルを追加する

📖 タスクの概要

パイプラインの範囲、期待値、使用パラメーター、トラブルシューティングログ、非標準機能の文書化には、いくつかの方法が考えられます。どの方法を選んでも、プロジェクトチームがそれを見つけられる場所を知っていることを確認してください。本チュートリアルでは、コードリポジトリのREADMEファイルとして文書化を追加します。

🔨 タスクの説明

1. ユーザーの flight_alerts_logic コードリポジトリを、ユーザーの .../Datasource Project: Flight Alerts/ フォルダーで開きます。

2. 新しいファイルを追加するため、新しいブランチ（Master から）を yourName/feature/add_readme という名前で作成します。

3. リポジトリの左上、ブランチ名のすぐ下にある ⊕ ボタンをクリックし、New file を選択します。

4. New file ウィンドウで、リポジトリファイル構造のルートに到達するまで左にスクロールします。そして、ルートフォルダーに新しいファイルを作成したいことを示すために \ をクリックします。下の画像のように表示されます。

   

5. ファイル名を README.md として、ウィンドウの右下にある青い Create ボタンをクリックします（ドロップダウンでファイルタイプを指定する必要はありません）。

6. 新しいファイルを開き、以下のブロックをエディターウィンドウに貼り付けます：

   ## Flight Alerts Pipeline
   
   #### Ownership
   
   * Project team: Aviation Data Development  
   
   * Project owner: yourName@yourOrganization.com
   
   #### Overview
   
   This pipeline takes raw data ingested from the Flight Alerts datasource and:
   1. Normalizes column names and data types across all raw datasets  
   
   2. Maps status codes from numbers to strings that represent their human meanings  
   
   3. Adds two null string columns (one for assignee, and one for comment) to be used in operational downstream workflows