File tree Expand file tree Collapse file tree 1 file changed +29
-0
lines changed
Expand file tree Collapse file tree 1 file changed +29
-0
lines changed Original file line number Diff line number Diff line change @@ -205,6 +205,35 @@ Item 2
205205 file_regression.check(doctree.pformat(), extension = " .xml" )
206206`````
207207
208+ ## Commit Message Format
209+
210+ Use this format:
211+
212+ ```
213+ <EMOJI> <KEYWORD>: Summarize in 72 chars or less (#<PR>)
214+
215+ Optional detailed explanation.
216+ ```
217+
218+ Keywords:
219+
220+ - ` ✨ NEW: ` – New feature
221+ - ` 🐛 FIX: ` – Bug fix
222+ - ` 👌 IMPROVE: ` – Improvement (no breaking changes)
223+ - ` ‼️ BREAKING: ` – Breaking change
224+ - ` 📚 DOCS: ` – Documentation
225+ - ` 🔧 MAINTAIN: ` – Maintenance changes only (typos, etc.)
226+ - ` 🧪 TEST: ` – Tests or CI changes only
227+ - ` ♻️ REFACTOR: ` – Refactoring
228+
229+ If the commit only makes changes to a single module,
230+ consider including the name in the title.
231+
232+ ## PR title and description format
233+
234+ Use the same as for the commit message format,
235+ but for the title you can omit the ` KEYWORD ` and only use ` EMOJI `
236+
208237## Pull Request Requirements
209238
210239When submitting changes:
You can’t perform that action at this time.
0 commit comments