Warning

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

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

learn.palantir.com でも以下の内容をご覧いただけますが、アクセシビリティの観点から、ここに掲載しています。

📖 タスクの概要

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

🔨 タスクの説明

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

  2. 新しいファイルを追加するので、Master から新しいブランチ(ユーザーの名前/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: ユーザーの名前@ユーザーの組織.com
    
    #### Overview
    
    このパイプラインは、Flight Alertsデータソースから取り込まれた生データを以下のように処理します。
    1. すべての生データセット間で列名とデータタイプを正規化します。
    
    2. ステータスコードを、その人間的意味を表す文字列にマッピングします。
    
    3. 操作下流ワークフローで使用するために、2つのnull文字列列(1つは担当者用、もう1つはコメント用)を追加します。