Github README.md 작성 주의 사항

Github을 사용할 경우, 레퍼지토리마다 README.md를 작성하게 된다.

여러 사람들이 참고할 수 있는 오픈 소스일 경우에는 특히, 다른 사람들이 프로젝트들 잘 이해할 수 있도록 도움이 필요하며, 이때 가장 접근하기 쉬운 방법이 README.md를 작성하는 방법이라고 생각한다.

왜 README를 작성하는 데에 시간을 투자해야 할까?

우선 README 파일은 Github 저장소에 올라온 프로젝트에 대해 안내를 해주는 가이드 문서이다.

1. 좋은 README는 자신의 프로젝트에게 차별화를 주는 데에 도움이 된다.
2. 프로젝트를 접할 때, 가장 먼저 보게 되는 화면이므로 상세하게 작성해야 한다.
3. 프로젝트가 제공해야 하는 것과 방식에 대해 알아가게 되어 큰 도움이 된다.

README 파일을 작성할 때에는 다른 개발자가 보고 이해할 수 있도록 염두해야 한다.

좋은 README 파일을 작성하는 방법

프로젝트 제목

• 프로젝트의 주요 목표가 무엇인지 이해할 수 있도록 한 문장으로 설명한다.

프로젝트 설명

• 잘 작성된 내용을 통해 추후에 능력으로 인정받을 수 있다.
  - 어플리케이션의 동작
  • 사용한 기술의 선택 이유
  • 이슈 혹은 향후 계획

프로젝트 설치 방법 및 버전 기록

• 설치가 필요한 경우 혹은 특정 버전에서만 동작하는 경우
  • 설치 방법 및 버전에 대해 상세하게 기록한다.
  • 혹은 개발 환경에 대한 내용을 제공해 주어도 좋다.

마지막 내 생각

개인적으로 READMD 파일은 개발 환경에서 가장 처음과 마지막이라고 생각한다.
- 제 3자가 처음 접하는 화면이기도 하고, 담당자가 배포 전 변경 사항을 작성하기 때문이다.

따라서 누군가에게는 귀찮을수도, 누군가에게는 세세하게 신경쓰지 않는 부분일 수도 있지만,
누군가에게는 도움이 된다는 생각과 열심히 참여한 프로젝트에 애정을 표현하는 단계라고 생각한다.

따라서 나의 행적을 기록하고, 스스로 표현할 수 있는 README를 작성했으면 한다.

읽어주셔서 감사합니다.

[참조 링크]

How to Write a Good README File for Your GitHub Project