search

szpp-dev-team / szpp-judge-frontend

MIT License
1 stars 0 forks source link

conventional commits を導入したい #6

Closed h-takeyeah closed 2 years ago

h-takeyeah commented 2 years ago

コミットメッセージを

feat(pages): 問題一覧ページを実装した # <-- title

close #xx     # <- body

のような形式で書くことを"勧める"、さらにできれば commitlint を使って"強制"したい。

feat の位置に来る言葉の選び方は↓などが参考になる。 https://github.com/AquiTCD/cz-conventional-changelog-ja/blob/master/commit-types.json

"feat": "新機能"
"fix": "バグ修正"
"docs": "ドキュメントのみの変更"
"style": "フォーマットの変更（コードの動作に影響しないスペース、フォーマット、セミコロンなど）"
"refactor": "リファクタリングのための変更（機能追加やバグ修正を含まない）
"perf": "パフォーマンスの改善のための変更"
"test": "不足テストの追加や既存テストの修正"
"ci": "CI用の設定やスクリプトに関する変更（スコープ例: Travis, Circle, BrowserStack, SauceLabs)"
"chore": "その他の変更（ソースやテストの変更を含まない）"
 "revert": "以前のコミットに復帰"
h-takeyeah commented 2 years ago

https://github.com/szpp-dev-team/szpp-judge-frontend/commit/5f71d7f6596f08486da95eb6d7c4066f171b372c で導入したのでクローズします。