3. PR 체크리스트 - HiDIKI/hidiki.github.io.build GitHub Wiki

체크리스트

  • 작성하는 문서는 markdown 형식이여야한다.
  • 문서의 h1(#)태그, 즉 타이틀은 * 로 시작한다.
  • 모든 문서에는 #(타이틀)이 존재해야 한다.
  • 문서의 경로는 md_docs > {category:language} > {title:path}.md이다.
  • 작성이 완료되면, md_docs > .vuepress > config.js의 sidebar영역에 연결 주소를 넣어준다
    • 단, 연결주소에 md확장자는 생략한다.
  • PR전에 로컬 개발환경에서 정상동작하는지 확인한다.
  • 글 내용은 합니다가 아닌 한다체여야 한다.
  • 가독성을 위해 문서의 헤드태그(#)은 가능하면(###)까지 사용한다.
  • 블로그가 아닌 위키라는 관점에서 보다 객관적인 수준의 포스팅을 진행한다.
    • 필자의 생각은 이러하다 (x)
    • ~ 한 것 같다(x)