11min Tutorial - Github

하루에 1번, 11분 tutorial - Github repository 관리

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

• template 제공 - 상단 초록색 버튼 Use this template을 사용해 템플릿으로 사용해보세요.
• 15분만에 익히는 Github repository 기능(샘플 포함)
  • 프로젝트를 멋지게 설명할 수 있는 README.md
  • 협업할 때 도움이 되는 issue, project board 관리
  • PR없이 할 수 있는 코드 리뷰 방법
  • gitignore 파일 (Flask, venv, VSCode, Jetbrains IDE(Pycharm,...)설정 무시)
• 다루지 않는 것 - 기본적인 Git 사용법, markdown 사용법, Pull Request, Github action / 추가 내용은 하단 Reference를 참고하세요.

주요 튜토리얼 Key Feature

• github repository 템플릿 - 상단 초록색 버튼 Use this template 을 클릭해 내 프로젝트의 템플릿으로 사용해보세요.
• 따라할 수 있는 README.md 샘플 : 프로젝트를 소개하는 README.md 를 참고할 수 있습니다.
• .gitignore 기본 설정 : git이 tracking하지 않을 파일을 지정하는 .gitignore 파일이 생성되어있습니다. 다른 개발환경에서는 필요없는 불필요한 설정파일을 github repository에 업로드하지 않습니다. (Flask, venv, VisualStudioCode, jetbrains의 IDE(Pycharm 포함)의 설정파일을 무시합니다)
• Commit Comment 남기기 : 작업내용(commit)에 바로 댓글을 달아보세요. PR없이도 Code Review 용도로, 질문하는 용도로 사용할 수 있습니다.
• issue Tutorial - issue 샘플 을 보며 issue 작성에 대한 감을 잡아보세요.
• issue 설정파일 제공 : issue 성격에 따라 다른 Issue template을 사용해보세요. / 설정파일
• 샘플 프로젝트 보드 를 참고해 내 프로젝트를 관리하세요.

가이드 예시

Contribution

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

Reference

• awesome-Git 자료 : git 학습에 도움이 되는 자료 모음
• 웹 기초 참고자료 by ohahohah - Git 파트
• Markdown tutorial / Markdown Cheat-sheet

Links

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

License

ohahohah – ohahohah.dev@gmail.com

MIT license를 준수합니다. LICENSE에서 자세한 정보를 확인할 수 있습니다.