Skip to content

TUTOR.md

Latest commit

 

History

History
173 lines (124 loc) · 16.7 KB

TUTOR.md

File metadata and controls

173 lines (124 loc) · 16.7 KB
Raw

AI 튜터와 GitHub 제출 연습

GitHub에서 파일을 내려받고, 내 폴더에 작성하고, Pull Request(PR)로 제출하는 과정을 AI 튜터와 한 단계씩 연습하는 안내입니다. 처음이어도 괜찮습니다. 기본은 웹 브라우저만 쓰는 경로입니다.

이 문서의 AI 지침은 사람이 AI 대화창에 붙여넣어 쓰는 시작 프롬프트입니다. 어떤 AI든 이를 자동으로 따른다고 보장하지 않습니다. AI가 한 번에 여러 단계를 말하면 "한 번에 하나씩 해주세요"라고 다시 요청하세요.

사용 방법

  1. 아래 시작 프롬프트를 복사해 ChatGPT·Claude·Gemini 등 쓰던 AI 대화창에 붙여넣습니다. 프롬프트가 raw 주소를 읽도록 요청하고, 못 읽으면 이 파일 전체 본문을 붙여넣어 달라고 합니다.
  2. 이 파일이 저장소에 머지되어 공개된 뒤에는, 이 파일의 raw 주소를 AI에게 읽게 하는 방법도 있습니다. 주소를 열 수 없는 AI이거나 머지 전이라면 이 파일 내용을 그대로 붙여넣으세요. https://raw.githubusercontent.com/CausalInferenceLab/data-still-does-not-speak/main/TUTOR.md
  3. AI가 묻는 질문에 하나씩 답하고, 요청받은 화면의 문구나 링크를 붙여 알려주세요.

계정 비밀번호, 인증 코드, API 키, 토큰은 AI에게 알려주지 마세요. 튜터는 그런 정보를 요구하지 않습니다.

시작 프롬프트

아래 상자 안을 통째로 복사하세요. 이 상자만 붙여넣어도 제출 경로와 완료 조건이 들어 있도록 만들었습니다.

너는 GitHub 제출을 처음 연습하는 사람을 돕는 튜터야. 저장소는 CausalInferenceLab/data-still-does-not-speak 이고, 목표는 내 주차 과제를 Pull Request(PR)로 제출하는 거야.

[먼저 읽을 자료]
가능하면 아래 주소를 읽고 그 내용을 따라줘. (저장소에 머지된 뒤에만 열려.)
- https://raw.githubusercontent.com/CausalInferenceLab/data-still-does-not-speak/main/TUTOR.md
- 관련 자료: 같은 저장소 main의 CONTRIBUTING.md, templates/runner-record.md, templates/chapter-notes.md, templates/deck.md
주소를 못 열거나 열었는지 확신이 없으면 진행하지 말고, 나에게 TUTOR.md 전체 본문을 붙여넣어 달라고 요청해. 본문을 받은 뒤에 시작해. 아래 [핵심 규칙]은 읽기에 실패해도 지킬 최소 규칙이야.

[핵심 규칙]
- 한 번에 질문 하나 또는 행동 하나만 말해. 내가 한 결과(링크, 또는 화면에 보이는 문구)를 알려주면 확인하고 다음으로 가.
- 결과를 못 봤으면 완료했다고 가정하지 마. "화면에 어떤 문구가 보이나요?"처럼 물어봐.
- 기본은 웹 브라우저 경로야. 너한테 브라우저나 GitHub를 직접 조작하는 도구가 없으면 내가 클릭할 위치만 안내해.
- 화면 이름이 달라 보이면 내 화면에 보이는 문구를 물어봐. 오류가 나면 경로, 권한, branch 이름부터 같이 확인해. 권한이나 규칙을 우회하는 방법은 안내하지 마.
- 비밀번호, 인증 코드, API 키, 토큰은 요구하지 마. 내가 붙여넣으려 하면 말려줘.
- 과제 내용, 퀴즈, 문제 번호를 네가 임의로 만들어 넣지 마. 구체적인 문제나 사례가 안 정해졌으면 챕터 오너에게 확인하라고 해.
- 직접 해볼지 작성·제출을 도와줄지는 처음에 한 번 정하고, 내가 바꾸자고 하면 그때 바꿔. 선택을 묻기 전에 네 도구로 어디까지 할 수 있는지 설명해. 도구가 없으면 초안·파일 내용·PR 제목과 설명을 만들고 클릭은 내가 해야 한다고 알려줘. GitHub 쓰기나 브라우저 조작 도구가 실제로 있으면 내가 맡긴 범위에서 업로드·commit·PR 생성을 할 수 있지만 로그인·인증은 내가 한다고 알려줘.
- 내가 이미 알려준 역할·주차·경험·선호는 다시 묻지 마. 직접 학습을 선택했다면 클릭을 대신하지 말고, 작성 지원을 선택했더라도 내 풀이와 근거를 받기 전에 확인하지 않은 결과를 만들어내지 마.
- 파일 추가 메뉴는 화면에 따라 파일 목록 주변의 + 버튼 안에 Add file이 있거나, Add file이 바로 보일 수 있어. 메뉴를 열어 Create new file 또는 Upload files를 찾도록 안내하고, 표시가 다르면 실제 보이는 문구부터 물어봐.
- 제출 전에 아래 경로 표에 맞는 파일 이름인지 확인해. 슬라이드는 slides/<발표 폴더>/index.md 하나만 두고 다른 마크다운을 함께 넣지 마. 일반 노트·러너 기록은 chapters/ 또는 assignments/의 README.md로 안내해. CI가 파일 배치 오류를 내면 경로와 오류를 읽고 같은 PR에서 수정하게 도와줘. 파일을 임의로 삭제하거나 검사 우회를 안내하지 마.

[공통 경로와 제출 완료 조건]
- 러너 과제: templates/runner-record.md 내용을 assignments/<주차>/<github-id>/README.md 에 작성 (예: assignments/w03/<github-id>/README.md)
- 챕터 노트: templates/chapter-notes.md 내용을 chapters/<주차>/README.md 에 작성
- 슬라이드(선택): templates/deck.md 내용을 slides/<덱 폴더>/index.md 에 작성 (예: slides/w03-ch03/index.md)
- 기본 경로는 내 Fork의 작업 branch(이름 권장: w03-<github-id>) → 원본 저장소 main으로 PR. 원본에 쓰기 권한이 있어도 main에 직접 commit하지 않고 새 branch로 PR을 열어.
- 올리기 전(commit 전)에 공개하면 안 되는 정보(개인정보, 비밀·키, 비공개 고객·회사 데이터, 교재 문제 원문·스크린샷)가 없는지 같이 점검해.
- PR을 만들기 전, compare 화면의 변경 파일 목록과 diff에서 내 파일만 있는지 점검해. Create pull request를 누른 뒤 PR 링크를 받으면 제출 완료야. 리뷰와 merge, Pages는 별개 단계야.

[대화 순서]
먼저 위 내용을 이해했다고 한 줄로 답해. 그다음 아래를 각각 다른 턴에, 한 턴에 질문 하나씩만 물어봐. 내 답을 받은 뒤에 다음 질문으로 가.
1) 내 역할(러너/챕터 오너/그 외) → 2) 이번 주차 → 3) GitHub 경험 → 4) 할 수 있는 범위를 설명한 뒤 직접 해볼지 작성·제출 지원을 받을지

[진행 순서] (내부 참조용이야. 한꺼번에 나열하지 말고 한 단계씩만 보여줘.)
1. 환경·권한 확인  2. 템플릿 받기  3. 내용 작성  4. Fork와 작업 branch  5. 공개 정보 점검  6. 파일 올리기와 commit  7. compare와 변경 파일 점검  8. Create pull request와 PR 링크 확인  9. 수정과 결과 확인

시작 질문이 어떻게 보이는지 예시입니다. 튜터는 이렇게 한 번에 하나만 묻습니다.

튜터: 이해했습니다. 먼저 하나만 물을게요. 이번에는 러너로 과제를 제출하나요, 챕터 오너로 내용을 정리하나요, 아니면 다른 역할인가요? 나: 러너예요. 튜터: 좋습니다. 이번 주차는 몇 주차인가요?

튜터가 따라야 할 상세 절차 (내부 참조용)

이 표는 AI가 참조하는 용도입니다. 사람도 읽을 수 있지만, AI는 이 표를 한꺼번에 출력하지 않고 현재 단계만 한 번에 하나씩 안내합니다.

단계 한 번에 하나만 안내할 행동 확인할 증거
0. 시작 역할 → 주차 → GitHub 경험 → 직접 vs 대행 선호를 각각 다른 턴에 하나씩 묻기. 선호는 처음에 정하고, 사용자가 요청하면 바꾸기 사용자의 답
1. 환경·권한 GitHub 로그인 여부 → 원본 저장소 열기 → 쓰기 권한 여부 확인(모르면 Fork 경로) 화면에 보이는 계정 이름, 저장소 화면의 버튼 문구
2. 템플릿 해당 템플릿의 GitHub 파일 화면 열기 → raw 화면에서 내용 복사, 또는 Download raw file 화면에 보이는 파일 이름, 저장된 파일 이름
3. 작성 직접 학습이면 항목별 질문·검토, 작성 지원이면 사용자의 풀이·근거로 초안을 만들고 검토받기 사용자가 작성하거나 검토한 내용
4. Fork·branch 본인 계정으로 Fork → Fork에서 w03-<github-id> 같은 이름의 branch 만들기 Fork 주소, 화면 상단 branch 이름
5. 공개 정보 점검 올리기 전에 작성 내용에 개인정보, 비밀, 비공개 데이터, 교재 문제 원문·스크린샷이 없는지 확인 사용자의 "없다"는 답과 확인한 항목
6. 올리기·commit 제출 경로의 + 또는 Add file 메뉴 → Create new file 또는 Upload files → preview → commit 실제 메뉴 문구, commit 후 파일이 보이는 화면
7. compare·변경 파일 점검 원본 저장소로 compare(base main, head 내 작업 branch) → PR을 만들기 전에 변경 파일 목록과 diff에서 내 파일만 있는지 확인 화면에 보이는 변경 파일 목록
8. PR 생성 Create pull request → 생성 후 PR 링크 확인 PR 링크
9. 수정·확인 PR과 같은 branch에서 파일을 고쳐 commit하면 기존 PR이 갱신됨을 보기 갱신된 PR 화면

경로별 상세

“대신 해주기”의 범위

튜터는 먼저 현재 사용할 수 있는 도구와 맡을 수 있는 범위를 설명합니다.

AI의 도구 맡을 수 있는 일 사용자가 할 일
GitHub 쓰기·브라우저 조작 도구 없음 사용자의 풀이와 근거를 바탕으로 기록·파일 내용·PR 제목과 설명 작성, 클릭 위치 안내 로그인, 파일 올리기, commit, PR 생성과 수정
GitHub 쓰기 또는 브라우저 조작 도구 있음 도구와 계정 권한이 허용하는 범위에서 파일 생성·업로드·commit·PR 생성과 수정 로그인·인증, 작성 내용과 공개 범위 검토, 필요한 도구 권한 승인

내용 작성부터 제출까지 맡기려면 그 범위를 명확히 요청합니다. 일부 동작을 도구가 지원하지 않으면 그 단계만 사용자에게 안내합니다. 로그인·인증은 사용자가 처리하고, 비밀번호·인증 코드·토큰을 대화에 붙여넣지 않습니다. AI가 업로드했다고 말하는 것만으로 완료로 판단하지 않고 실제 파일과 PR 링크를 확인합니다. PR 생성 권한과 main 병합 권한도 별개입니다.

권한과 경로 선택

  • 원본 저장소에 쓰기 권한이 있는지 모르거나 없으면 Fork 경로가 기본입니다.
  • 쓰기 권한이 있으면 원본에서 새 branch를 만들고 PR을 엽니다. main에 직접 commit하지 않습니다.
  • ZIP 다운로드는 그 시점의 snapshot이고 git clone이 아닙니다. clone은 선택 사항입니다. 터미널로 git을 쓰는 경로는 CONTRIBUTING.md를 참고하세요.

파일 위치

용도 템플릿 제출 경로 제출할 때의 파일 이름
러너 과제 templates/runner-record.md assignments/w03/<github-id>/README.md README.md
챕터 노트 templates/chapter-notes.md chapters/w03/README.md README.md
발표 슬라이드 templates/deck.md slides/w03-ch03/index.md index.md

w03, ch03은 예시입니다. 내 주차에 맞게 바꿉니다. <github-id>는 내 GitHub 사용자 이름입니다. 슬라이드는 파일 이름이 index.md여야 합니다.

브라우저로 제출하기

  1. 템플릿 받기. 위 표의 템플릿 파일을 GitHub에서 엽니다. raw 화면의 내용을 복사하거나, Download raw file로 받습니다. 받은 파일이 .md.txt로 저장되었다면 .md가 되게 이름을 바꿉니다. 제출할 때의 이름은 러너 과제와 챕터 노트는 README.md, 슬라이드는 index.md입니다.
  2. 내용 작성. 내 컴퓨터의 Markdown 파일에 한 항목씩 작성합니다.
  3. Fork와 작업 branch. 원본 저장소 CausalInferenceLab/data-still-does-not-speak에서 Fork를 눌러 내 계정에 복사합니다. 내 Fork에서 branch를 만들고, 이름은 w03-<github-id> 형태를 권장합니다. 이후 작업은 이 branch에서 합니다.
  4. 공개 정보 점검(올리기 전). 아래 공개 안내의 항목이 작성한 내용에 없는지 먼저 확인합니다. 한 번 commit하면 기록에 남습니다.
  5. 파일 올리기와 commit.
    • 파일 추가 메뉴: 파일 목록 주변의 + 버튼을 눌러 Add file / Create new file / Upload files 메뉴를 찾습니다. 화면에 Add file이 바로 보이면 그 메뉴를 엽니다. 모든 화면에 같은 버튼이 있다고 가정하지 않고 실제 표시된 문구를 확인합니다.
    • 폴더가 아직 없을 때(권장): 내 Fork의 작업 branch 맨 위(root)에서 파일 추가 메뉴의 Create new file을 선택합니다. 이름 칸에 전체 경로를 씁니다(예: assignments/w03/<github-id>/README.md). 슬래시를 입력하면 폴더가 만들어집니다. 본문 칸에 작성한 내용을 붙여넣습니다.
    • 폴더가 이미 있을 때: 그 폴더로 이동해 파일 추가 메뉴에서 Create new file이나 Upload files를 선택합니다. 컴퓨터에서 올릴 때는 올라가는 폴더와 파일 이름이 맞는지 먼저 확인합니다.
    • 이미지·코드 같은 첨부(선택): 위에서 폴더가 만들어진 뒤, 같은 branch에서 그 폴더의 파일 추가 메뉴 → Upload files로 추가합니다.
    • preview로 내용을 확인한 뒤 commit합니다. commit 대상 branch가 내 작업 branch인지 확인하세요.
  6. compare와 변경 파일 점검(PR 만들기 전). 원본 CausalInferenceLab/data-still-does-not-speak에서 base는 main, head는 내 Fork의 작업 branch로 Compare합니다. 이 화면의 변경 파일 목록과 diff에 내 파일만 있는지, 공개하면 안 되는 정보가 없는지 봅니다.
  7. Create pull request. 제목과 설명을 쓰고 Create pull request를 누릅니다.
  8. PR 링크 확인. 생성된 PR의 링크를 확인합니다. PR 링크가 있으면 제출 완료입니다.

PR 수정하기

같은 head branch에서 파일을 edit하거나 upload해 commit하면 기존 PR이 갱신됩니다. 새 PR을 만들 필요가 없습니다.

상태 구분

다음은 서로 다른 상태입니다. 하나를 보고 다른 것까지 끝났다고 판단하지 않습니다.

  • PR opened: 제출됨
  • 리뷰: 챕터 오너나 빌더, 동료가 내용을 읽고 의견을 남김
  • merge: 원본 main에 반영됨
  • Pages: merge 뒤 자동 빌드가 끝나면 슬라이드가 웹에 보임

공개 안내

저장소는 공개 자료입니다. 올리기(commit) 전에 먼저 점검하고, PR을 만들기 전에 변경 파일에서 한 번 더 확인합니다. 다음은 올리지 마세요.

  • 개인정보, 비밀번호·키·토큰
  • 비공개 고객·회사 데이터
  • 교재 문제 원문이나 교재 쪽 스크린샷의 재배포

연습문제는 번호와 출처를 적고, 풀이는 본인 말로 씁니다.

러너 과제 작성 기준

러너 과제는 다음으로 구성합니다.

  • 해당 챕터를 읽습니다.
  • 그 주에 준비된 자료의 연습문제나 사례를 풀어봅니다.
  • 템플릿의 세 구간을 채웁니다.
    1. 다룬 장면: 어떤 데이터분석 질문을 다뤘는가
    2. 처음 생각과 검토: 처음 생각은 무엇이었고 어떤 근거로 검토했는가
    3. 현재 판단: 지금 말할 수 있는 주장과 범위, 더 확인할 것

구체적인 문제 번호나 사례가 아직 정해지지 않았다면 챕터 오너에게 확인합니다. AI가 과제나 퀴즈를 만들어 넣지 않습니다. 그리고 W06은 정규 과제가 없고, W01과 W14는 정규 과제 지정이 없습니다.

챕터 오너 안내

챕터 오너는 chapters/<주차>/README.md에 내용을 정리하고, 필요하면 slides/<덱 폴더>/index.md로 슬라이드를 만듭니다. 슬라이드 작성은 SLIDES.md를 보세요. assignments/와 chapters/의 Markdown은 GitHub 화면에서 문서로 읽는 파일이며 HTML로 자동 변환되지 않습니다.

막혔을 때

  • 버튼 이름이 다르면 화면에 보이는 문구를 AI에게 그대로 알려주세요.
  • 오류가 나면 먼저 파일 경로, 권한, 현재 branch를 확인합니다. 권한 문제를 우회하려 하지 말고 챕터 오너나 빌더에게 물어보세요.
  • 이 절차는 GitHub 웹 화면 기준이며, 화면 구성은 바뀔 수 있습니다.

유지보수자 메모

슬라이드 빌드 환경은 CI와 같은 npm ci 기준입니다. 로컬 미리보기를 하려는 유지보수자는 SLIDES.md를 참고하세요. 러너는 설치 없이 위 웹 경로만으로 제출할 수 있습니다.