Github를 사용해 간단하게 프로젝트 관리 툴 사용해보기

프로젝트에서 사용할 수 있는 편리한 도구 프로젝트 소개 README.md, issue, PR, Project board

유용하게 쓰셨다면 상단 star 를 눌러주세요!

주요 화면

핵심 기능 Key Feature

• template 제공 - 상단 초록색 버튼 Use this template을 사용해 템플릿으로 사용해보세요.
• 프로젝트 파악을 위한 기본 설명 README.md
• issue
  • 작업 또는 버그 추적, 아이디어, 피드백(comment, 멘션 @사용자이름 등)
  • label, assignees 으로 관련자 할당, 이슈 성격
  • 프로젝트 차원에서 관리 project board, milestone
  • issue 설정파일: issue 성격에 따라 다른 Issue template을 사용해보세요. / 설정파일
• Branch 전략(github flow, gitlab flow, git flow 등)은 하단 참고자료를 참고
• PR
  • PR 설정파일
• issue, PR 카드 포함한 프로젝트 관리 project board
• PR없이 할 수 있는 코드 리뷰 방법 - Commit Comment
  • PR을 할 경우, 되도록 PR 내 코드리뷰 기능을 활용 권장. 사용하지 않을 경우, 작업내용(commit)에 댓글 달기. PR없이도 Code Review 용도로, 질문하는 용도로 사용할 수도 있음.
• gitignore 파일
  • git이 추적할 필요가 없는 설정 파일 등. 예: 내 로컬 개발환경 외에 필요없는 불필요한 설정파일(venv, IDE설정), 공개되면 안되는 보안 파일
• 샘플 프로젝트 보드 를 참고해 내 프로젝트를 관리하세요.

프로젝트 포트폴리오로 사용할 경우 아래 추가하면 상대가 파악하기 쉽습니다.

아키텍쳐

API 리스트

ERD

트러블슈팅

Contribution

• Contribution을 환영합니다.
• github issue 로 먼저 Feature, Bug fix 제안을 선호합니다만 바로 PR만 해도 괜찮습니다. (참고. 첫 기여하기)

Reference

• github 튜토리얼
• Markdown tutorial / Markdown Cheat-sheet

Links

• Project homepage: https://github.com/siyoungoh/proj-template/
• Repository: https://github.com/siyoungoh/proj-template/
• Issue tracker: https://github.com/siyoungoh/proj-template/issues
  • 보안 취약점 등의 민감한 이슈인 경우 이메일 주소로 연락주십시오.
• 관련 프로젝트
  • Git README 템플릿 : https://github.com/템플릿

License

SiyoungOh – 이메일주소

MIT license를 준수합니다. LICENSE에서 자세한 정보를 확인할 수 있습니다.
https://github.com/yourname/yourproject/wiki