해당 프로젝트 / 앱의 제목과 어떠한 프로젝트 / 앱인지를 간단하게 소개
해당 프로젝트 / 앱을 실제로 이용하기 위한 실행 방식을 순차적으로 기재
해당 프로젝트 / 앱이 어떠한 라이센스를 이용중인지 기재
오픈소스 시대에 개발자라면 본인이 진행하였던 프로젝트 관련 개발일지를 개인 블로그나 온라인 문서로 남기는 게 좋다 라는 조언들이 자주 있었다.
사실 조언 받기 이전부터 docx나 hwp 파일로 나만이 알아볼 수 있는 짧은 형식의 보고서를 쓰긴 하였지만, 이제는 gist 에 전부 남겨 보려 한다.
이를 통해 단순히 커밋만 되어 있는 프로젝트들을 문서화된 내용으로 좀 더 많은 사람에게 디테일하게 공유하고 시간이 지나면 나 자신도 잊게 될 내용을 다시 한번 떠올릴 수 있는 복습용으로도 쓰이지 않을까 싶다.
또한 md 파일 형식으로 작성해 나갈 계획이라 프로젝트 저장소 README.md 에만 간략하게 쓰던 마크다운 문법을 좀 더 자유자재로 다룰 수 있을 것으로 기대된다.
#!/bin/bash | |
URL="slack 채널URL" | |
USER=$(git config --get user.name) | |
while read oldrev newrev refname | |
do | |
# 마스터 브랜치인 경우에만 처리 | |
if [ "$refname" == "refs/heads/master" ]; then | |
# 현재 커밋 메시지를 가져오기 | |
LOG=$(git log -1 --pretty=%B) |