12 - 소스 레포지토리에 README 파일 추가하기

📖 작업 소개

파이프라인의 범위, 기대치, 사용 파라미터, 문제 해결 로그, 비표준 기능을 문서화하는 방법은 여러 가지가 있을 수 있습니다. 어떤 방법을 선택하든 프로젝트 팀이 그것을 어디에서 찾을 수 있는지 알고 있는지 확인하세요. 이 튜토리얼에서는 코드 레포지토리에 README 파일로서 문서를 추가하게 됩니다.

🔨 작업 지침

1. .../Datasource Project: Flight Alerts/ 폴더에서 flight_alerts_logic 코드 레포지토리를 엽니다.

2. 새 파일을 추가하게 될 것이므로, yourName/feature/add_readme라는 이름의 새 브랜치(Master에서)를 생성합니다.

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