우테코에서 알려준 가이드는 AngularJS Commit Convention이다. 그러나...나는 이걸 하나하나 훑어보기엔 영어실력이 나쁘다... 시간도 오래걸리고...
그래서 다른분들의 블로그와 포스팅들을 참고하여 정리하려고한다.
기본적으로 아래처럼 subject
, body
, footer
즉 제목/본문/꼬리말로 구성된다. (왼쪽이 본문, 오른쪽이 한글로 해석)
⭐주의⭐
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
눈에 잘 띄기 위해 한글로 하면 아래와 같다.
<종류>(<scope>): <제목>
<본문>
<꼬리말>
위 예시에서 부분에 들어갈 수 있는것은 아래와 같다.
Angular 9 규약에서 chore가 삭제되고 buildl, ci, perf가 추가 되었다고한다.
그러나 우테코에서 보내준 링크에는 이전버전을 사용하는 듯하여 새로 추가된 사항에 대해서는 참고를 위해 따로 정리하였다.
Angular 9에서는 chore를 안쓰고 아래 3개가 추가된다.
직역하면 범위이고, scope의 의미는 아마 위치인것 같다.
ex) Closes #123, #245, #992
IssueTracking에 대한 포스팅 하나. ⇒ 클릭!
"이슈 트래커"라고 검색하였음.
feat: Summarize changes in around 50 characters or less
More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.
Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequenses of this
change? Here's the place to explain them.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded
by a single space, with blank lines in between, but conventions
vary here
If you use an issue tracker, put references to them at the bottom,
like this:
Resolves: #123
See also: #456, #789
사실 본문에서 옮기지 않은 것 중에 Goals라는 부분이 있다. 이 컨벤션의 목표인데 그중하나가
즉, CHANGLOG.md를 작성하는 것이다. 직역하니 변경내역을 로깅 하는 것이다.
⭐ Changelog.md를 생성하는 법은 [여기](https://github.com/github-changelog-generator/github-changelog-generator)를 참고. 그리고 혹시 모른다면 md는 markdown의 약자이다. (찡긋 내가 몰랐던거다)변경내역에는 다음 3가지가 포함된다.
⇒ 새로운 기능
⇒ 버그 수정
⇒ 주요 변경 내용
배포할 때 스크립트를 사용해서 관련커밋에 대한 링크와 함께 위 내용들을 생성 할 수 있다.
물론 실제로 배포하기 전에 변경 내역을 수정하고난 뒤에 배포할 수도 있다.
git log <last tag> HEAD --pretty=format:%s
git log <last release> HEAD --grep feature
더 자세한 것을 알고 싶다면 아래 참고에서 outstanding님의 번역본을 보는것을 추천한다!!
참고한 링크 입니다. 정말 감사합니다!
거의 대부분의 내용: bosl95님의 velog
한글로 번역한 내용: outstanding님의 velog
배우는 과정이라 잘못된 정보가 있을 수도 있습니다!! 잘못된 점이 있다면 언제든 알려주세요!!!