Task 리스트 — 진짜로 commit 되는 체크박스 · Markup Quest

GitHub 가 진지하게 다루는 체크박스 리스트

GFM task 리스트는 [ ] (미완료) 나 [x] (완료) 로 시작하는 unordered list 항목이야. 대괄호는 list 마커 바로 뒤에, 공백 한 칸 띄고 와야 해.

GitHub 에서 달라지는 것

issue, PR, discussion 에서는 task 리스트 항목이 눌러지는 체크박스 로 렌더링돼. write 권한이 있으면 누구나 토글할 수 있고, 한 번 토글하면 그게 issue 본문에 진짜 수정으로 박혀. issue 의 edit history 에 흔적이 그대로 남는다는 뜻이야.

GitHub 는 PR description 의 task 리스트로 완료율 까지 계산해. PR 목록에서 제목 옆에 '3 / 8' 이 뜨는 게 그거야. 공짜로 얻는 진행 표시줄이지.

Task 중첩

일반 리스트 중첩이랑 똑같이 2 칸씩 들여쓰면 돼. 중첩된 task 도 중첩된 체크박스로 나와. 부모와 자식은 서로 따로 놀아. 부모를 토글해도 자식이 따라서 켜지진 않아.

원칙: issue 안의 task 리스트는 팀과 맺은 계약이야. 박스 하나가 확인 가능한 최소 단위 하나여야 해. '성능 개선' 처럼 뭉뚱그린 항목은 체크박스 자격이 없어. 'users.email 에 인덱스 추가' 정도로 구체적이면 자격이 있고.

Code

기본 task 리스트·markdown

- [ ] Read the spec
- [x] Sketch the schema
- [ ] Write the migration
- [ ] Add tests

중첩 task (서브스텝)·markdown

- [ ] Ship release v2
  - [x] Tag the commit
  - [x] Update CHANGELOG
  - [ ] Push the tag
  - [ ] Announce in #general

일반 bullet 와 섞기·markdown

- Notes (no checkbox, just context)
- [ ] Action: file the bug
- [ ] Action: run the migration
- Owner: @cwk

Exercise

진행 중인 issue 나 PR description 하나 열어봐. 할 일 이름이 적힌 평범한 bullet 을 전부 task 리스트로 바꿔. 한 번 쓰고 마는 글이던 issue 가 그 자리에서 살아 있는 tracker 로 바뀌는 걸 봐. 그 다음 GitHub UI 에서 박스 몇 개를 토글하고, edit history 에 차곡차곡 쌓이는 것까지 확인해.

Task 리스트 — 진짜로 commit 되는 체크박스

GitHub 가 진지하게 다루는 체크박스 리스트

GitHub 에서 달라지는 것

Task 중첩

Code

External links

Exercise

Progress

댓글 0