5B. [Repositories] Code Repositories での共有ライブラリの公開と使用15 - パイプラインにREADMEファイルを追加してドキュメント化する

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

15 - パイプラインにREADMEファイルを追加してドキュメント化する

📖 タスクの概要

データフローグラフをドキュメントとして追加しました。これで passengers リポジトリに README ファイルを追加し、さらなる詳細を追加します。

🔨 タスクの説明

  1. passengers_logic コードリポジトリを開きます。
  2. ブランチ ( Master から) を yourName/feature/add_readme という名前で新しく作成します。
  3. リポジトリの左上のブランチ名のすぐ下にある ボタンをクリックし、新規ファイル を選択します。
  4. 新規ファイル ウィンドウで、リポジトリのファイル構造のルートに達するまで左にスクロールします。そして、ルートフォルダーに新しいファイルを作成したいことを示すために、/ をクリックします。下図のように表示されます。

  1. ファイル名を README.md にして、ウィンドウの右下の青い 作成 ボタンをクリックします。

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

    ## 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   
    
  3. コードをコミットします (例: “feature: add readme”)。

  4. PRプロセスを完了して、ブランチを Master にマージします。CI チェックが通るまで待ってからマージを完了する必要があります。