[스파르타코딩클럽] 핵심 쏙쏙 Git - 3주차 (2) 커밋메세지 / 오픈소스 / 깃허브프로필

posinity·2023년 5월 25일
1

commit 으로 소통하기 - commit 메시지, 단위

좋은 커밋 관련 참고자료

NHNCloud - 좋은 git 커밋 메시지를 작성하기 위한 7가지 약속

commit 단위

커밋 단위에는 일관된 규칙이 있는 것이 좋다.
버그를 찾기 위해 작업 기록을 볼 때 단위가 잘 나누어져 있어야 버그가 나는 부분을 잘 찾을 수 있음
예시) 1. 작게 쪼갤 수 있는 기능 단위로 커밋하기 > 메뉴바 커밋 / 카카오 로그인 기능 커밋
2. issue 단위로 커밋

좋은 네이밍을 위한 자료

좋은 git commit 메시지를 위한 영어 사전

소스트리에서 커밋 템플릿 설정 방법 -mac만 가능

템플릿 다운받기 링크

소스트리 설정 > 상단 커밋 누르기
가져오기 눌러서 다운받은 파일 선택하기

코드리뷰

구글 코드 리뷰 가이드

Google 코드 리뷰 가이드 문서
Google 코드 리뷰 가이드 한글 번역(비공식) by soojinro

다른 회사의 코드리뷰 방법 살펴보기

구글에서 회사이름 + 코드리뷰 검색

코드 리뷰 in 뱅크샐러드 개발 문화

코드리뷰 하는 법

이슈에서 커밋에 들어가 리뷰하고 싶은 코드의 플러스 버튼을 클릭한다

Git 프로젝트 관리 - gitignore

.gitignore : 공유하거나 공개되면 안되는 파일들을 git에 올리지 않게 설정하는 파일

mac 에서 숨김파일 보기 : command + shift + . 을 누를 때마다 숨김 파일이 보였다가 보이지 않았다가 합니다.

Git 프로젝트 관리 - README

  • README : 프로젝트나 소프트웨어 사용할 때 먼저 읽어야하는 정보를 적어두는 파일

markdown(마크다운)

  • markdown(마크다운) : 서식이 적용된 텍스트 파일

마크다운 문법

# 제일 크게 - heading1
## 그 다음 크게 - heading 2
### 그 다음 크게 - heading 3

* 글머리기호(bullet point)
  * 앞에 두 칸 띄고 적으면 한 탭 들어간 글머리 기호

1. 순서를 줄 수도 있어요. 
2. 두번째 
3. 세번째!

**굵은 글씨(문자열 앞 뒤로 빈 칸이 없어야함)**

*이탤릭채(문자열 앞 뒤로 빈 칸이 없어야함)*

```python
# 코드 조각
print("Hello World")
//```

readme 양식

readme 양식 깃허브

<img src="https://user-images.githubusercontent.com/17819874/79853717-5db2f900-8403-11ea-99ba-ed0bb3cdb9ef.png" height="100"/>

# 프로젝트 이름  
[![made-with-Markdown](https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg)](http://commonmark.org)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/ohahohah/readme-template/graphs/commit-activity) 
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)



> 프로젝트 간략 소개 한 문장 
- 웹사이트 url / (챗봇일 경우)텔레그램 등 메신저 주소
- 사이트에 대한 1-2단락 설명

## 핵심 기능  Key Feature
- (예시) 실시간 지역별 날씨에 맞는 옷차림 정보를 알려줍니다.
- (예시) 미세먼지 정보를 파악할 수 있습니다.

## 사용 How To Use
- 사용하고 싶도록 유용한 몇 가지 예를 적습니다. 코드 블록과 스크린샷 포함.
- (wiki가 있을 경우) _더 많은 예시와 사용 예제는 [Wiki](wiki)를 참고하세요._
![](header.png)

## Contributing
*(프로젝트 기여자가 있을 경우 적습니다)*
- Thanks to @기여자이름

## Reference
*(참고 리소스,  code snippet, 라이센스 정보를 표기합니다)*
- (예시) [네이버 지도 API](링크url) : 장소카드 지도화면에 사용
- (예시) [Teachable Machine](https://teachablemachine.withgoogle.com/) : 절하는 pose MachineLearning Model 

## Links
*(사람이 읽기 쉽게 요약된 링크 정보를 추가합니다)*
- Project homepage: https://your.github.com/awesome-project/
- Repository: https://github.com/yourname/github-link
- Issue tracker: https://github.com/yourname/github-link/issues
  - 보안 취약점 등의 민감한 이슈인 경우 yourcontact@email.com 로 연락주십시오. 
- 관련 프로젝트
  - 프로젝트 이름 : https://github.com/yourname/other-project/
  - 프로젝트 이름: https://github.com/someones/awesome-project/

## License
*(공동작업자가 있을 경우 모두 적어줍니다)*  
이름1 – [이메일 주소1](mailto:이메일주소@example.com)  
이름2 - [이메일 주소2](mailto:이메일주소@example.com)  

XYZ license를 준수합니다. ``LICENSE``에서 자세한 정보를 확인할 수 있습니다.  
[https://github.com/yourname/github-link/LICENSE.md](https://github.com/ohahohah/)

github에서 정보 얻기

프로그래밍은 문제 해결! 해결을 위해 정보와 도구를 잘 사용하는게 필요하죠!
빠르게 변하는 기술 속에서 어떻게 좋은 정보를 얻을 수 있을까요?

좋은 프로젝트의 요소

  1. 해당 기술 또는 프로그래밍 언어를 잘 사용함 → 공식 튜토리얼, 공식 문서의 코드 조각, 공식 개발 프로젝트
  2. 다른 사람들에게 유용한 프로젝트 → 많은 사람들에게 반응이 좋고 널리 쓰이는 프로젝트

Github Trending User

오픈소스

오픈소스 기여 가이드

오픈소스 기여 가이드

오픈소스 컨트리뷰션

프로젝트에 상관없이 여러 프로젝트에 오픈소스 컨트리뷰션를 같이 하는 행사를 가지기도 해요! 전 세계적으로 가을에 하는 헥토버페스트 Hacktoberfest 가 유명하고, 한국에서는 '스프린트 서울', '파이콘 한국 스프린트', '오픈소스 컨트리뷰톤' 등이 정기적으로 열리고 있어요.

오픈소스 컨트리뷰션에 도전하고 싶다면

컨트리뷰터에 첫 도전하는 사람들을 위한 프로젝트 by Github

github 프로필 꾸미기

새로운 레포지토리 만들기 버튼을 클릭하고,
Repository name 은 내 github name 과 같게, public, Add a REAEME file 을 선택한다

profile
문제를 해결하고 가치를 제공합니다

0개의 댓글