News & Events
이 포스팅은 필자가 Github을 사용하는 동안 발견한 유용한 팁을 정리한 것이다. 아래의 정보들은 오랜 시간동안 다양한 소스로부터 수집되어 왔다. 따라서 너무 익숙한 것들은 제외시켰다. 필자는 여러분들에게 아래 리스트가 도움이 될 거라고 확신하고 있고, 여러분들이 일상 업무에 사용할 수 있기를 바란다.
먼저 코드를 로컬 환경에 복제하는 대신 Github 저장소를 통해 직접 코드를 편집하려는 경우가 있다. 여기엔 두 가지 방법이 있다.
Github의 웹 기반 에디터
웹 기반 에디터는 저장소에서 직접 코드 변경 사항을 만들고 커밋할 수 있는 가벼운 무료 편집기 환경이다. 다음과 같은 방법으로 웹 기반 에디터에서 모든 GitHub 저장소를 열 수 있다.
- GitHub에서 저장소를 탐색하는 동안 ( . ) 키를 누른다.
- URL을 github.com 에서 github.dev로 변경한다.
Colab에서 GitHub Jupyter 노트북 바로 열기
또한 Colab에서 Github 노트북을 직접 열 수도 있다. URL에서 github를 githubtocolab 으로 대체하고 다른 모든 항목은 그대로 둔다. 이렇게 하면 Colab에서 동일한 노트북이 열린다.
README는 프로젝트의 범위 및 기타 세부 정보를 다른 사람에게 알리기 위해 Github 저장소에 있는 마크다운 파일이다. readme 파일에 포함된 몇 가지 사항으로는 기여 지침, 행동 강령, 프로젝트 작업 등이 있다.
README 파일 자동으로 생성하기
README를 쉽게 만들고 사용자 정의할 수 있는 readme.so 라는 편리한 도구가 있다. 내용을 편집하려면 섹션을 클릭하기만 하면 되는 간단한 에디터이다. 그러면 해당 섹션이 readme에 추가된다.
프로파일 수준 README 작성
또한 GitHub 프로필 페이지를 사용자 정의하여 표시할 정보를 포함할 수도 있다. Github profile Readme는 README.md 파일이 들어 있는 퍼블릭 저장소이며 프로필 페이지의 맨 위에 나타난다. Github 페이지에 표시하려는 모든 콘텐츠가 이 README.md 파일에 포함되어야 한다. 그러나 명심해야 할 몇 가지 사항이 있다.
- 저장소 이름은 GitHub 사용자 이름과 일치해야 한다. 예를 들어 사용자 이름이 octo,인 경우 저장소 이름은 octo여야 한다.
- 저장소는 퍼블릭이어야 한다.
- 저장소의 루트에 README.md 파일이 있어야 하며 일부 컨텐츠로 채워져야 한다.
README에 대해 아이디어를 얻으려면 matiassingers/awesome-readme를 확인해보자.
이제 Github의 유용한 브라우저 확장 및 앱을 살펴보자.
Octotree
Octotree는 GitHub 코드 검토와 탐색을 강화한 브라우저 확장이다. 익숙한 트리 구조로 디렉토리를 탐색하고 파일을 여는 데 도움이 된다.
Octoclairvoyant
Octoclairvoyant는단일 뷰에서 여러 릴리스의 GitHub 변경 로그를 필터링하고 비교하는 도구이다. 특정 변경 사항이 적용된 버전과 다른 이점들을 쉽게 확인할 수 있다.
Github URL Shortener
Github에는 Github 저장소의 URL을 줄여주는 Git.io이라는 자체 URL 단축어가 있다.
Wiki 및 설명서 작성에 유용한 몇 가지 형식 지정 팁이 있다.
텍스트가 버튼처럼 나타나도록 하려면 <kbd> 태그를 붙이면 텍스트를 버튼 형식으로 변환할 수 있다. 이것은 문서를 작성할 때 유용하다.
Pressing the <kbd> .</kbd> key while browsing any repository on GitHub.
Magic Markdown tables
Table-magic 은 CSV, TSV, Markdown, SQL 및 HTML을 포함한 여러 테이블 형식 간에 쉽고 빠르게 변환할 수 있는 오픈 소스 도구이다.
마지막으로, Github의 뛰어난 시각화 프로젝트가 있다.
Github Octo
Github Octo 프로젝트는 코드베이스의 조감도를 자동 생성하고 코드가 어떻게 구성되는지 이해하는 방법이다. 아래 그림은 H2O.ai의 H2O-3 저장소를 시각화한 것이다. 클릭해서 직접 해보자!
맺음말
이것들은 필자가 유용하다고 생각하는 Github 기능들 중 일부였습니다. 이미 알고 있는 기능들도 있겠지만 위의 것 외에도 유용한 기능들이 더 있다면 제가 이 글에 추가할 수 있도록 코멘트에 올려주시면 좋을 것 같습니다.
번역 – 핀인사이트 인턴연구원 강지윤(shety0427@gmail.com)
원문 보러가기>
https://towardsdatascience.com/a-tour-of-10-useful-github-features-d92dde0bf412