해당 포스트는 Hadley Wickham이 작성한 'The tidyverse style guide' 를 번역하여 정리한 글입니다.
Lists
Intro - 0. Welcome
Analysis - 1. Files
Analysis - 2. Syntax (1)
Analysis - 2. Syntax (2)
Analysis - 3. Functions
Analysis - 4. Pipes
Analysis - 5. ggplot2
Packages - 6. Files
Packages - 7. Documentation
Packages - 8. Tests
Packages - 9. Error messages
Packages - 10. News
Packages - 11. Git/GitHub
11. Git과 Github (Git/GitHub)
11.1 커밋 메시지(Commit messages)
표준 git 커밋 메시지 조언에 따르는 것이 좋습니다. 요약하면 아래와 같습니다.
- 첫 번째 줄은 제목이며, 커밋의 변경 내역을 50자 이내로 요약해야 합니다.
- 만약 추가 정보가 필요한 경우, 빈 줄을 추가한 다음 단락 형식으로 설명 및 컨텍스트를 제공하시면 됩니다.
- 커밋이
Github문제를 해결하는 경우#<issue-number>를 포함하십시오. 이렇게 하면 마스터로 병합(merge)될 때 자동으로 이슈(issue)가 완료(closed)되게 됩니다.
11.2 풀 리퀘스트(Pull requests)
풀 리퀘스트(Pull requests) 제목은 변경사항을 간략히 설명해야 합니다. 제목은 독립형이어야 하며 관련 이슈 번호(issue number)를 포함하지 않아야 합니다. (예: Fixes #10를 쓰지마십시오.)
매우 간단한 변경의 경우, diff를 보면 자세한 내용을 설명할 필요가 없으므로 설명(description)을 공백으로 비워둘 수 있습니다. 보다 복잡한 변경의 경우에는 변경 사항에 대한 개요(overview)를 제공해야 합니다. 만약 PR로 문제가 해결되면 Fixes #<issue-number> 설명에 포함하시는게 좋습니다.
출처
[1] The tidyverse style guide
[2] Standard git commit message advice
▲ The tidyverse style guide 원문 다운받기