@@ -57,3 +57,71 @@ make check
57572. To notify reviewers that the PR is ready for review, click **Ready for review** at the bottom of the page.
5858
59593. Engage in any discussions raised by reviewers and address any changes requested. Set the PR to draft PR mode while you address changes, then click **Ready for review** to re-request review.
60+
61+ ### Pull Request Requirements
62+
63+ Basic Structure
64+
65+ <type>: <subject>
66+
67+ <body>
68+
69+ <footer>
70+
71+ Type (required, lowercase)
72+ ┌──────────┬──────────────────────────────┬────────────────────────────────┐
73+ │ Type │ Description │ Example │
74+ ├──────────┼──────────────────────────────┼────────────────────────────────┤
75+ │ feat │ New feature │ feat: add user login │
76+ ├──────────┼──────────────────────────────┼────────────────────────────────┤
77+ │ fix │ Bug fix │ fix: resolve memory leak │
78+ ├──────────┼──────────────────────────────┼────────────────────────────────┤
79+ │ docs │ Documentation changes │ docs: update README │
80+ ├──────────┼──────────────────────────────┼────────────────────────────────┤
81+ │ style │ Code formatting only │ style: fix indentation │
82+ ├──────────┼──────────────────────────────┼────────────────────────────────┤
83+ │ refactor │ Code restructuring │ refactor: simplify auth module │
84+ ├──────────┼──────────────────────────────┼────────────────────────────────┤
85+ │ perf │ Performance improvements │ perf: reduce query time │
86+ ├──────────┼──────────────────────────────┼────────────────────────────────┤
87+ │ test │ Test-related changes │ test: add unit tests │
88+ ├──────────┼──────────────────────────────┼────────────────────────────────┤
89+ │ build │ Build system or dependencies │ build: upgrade to webpack 5 │
90+ ├──────────┼──────────────────────────────┼────────────────────────────────┤
91+ │ ci │ CI/CD configuration │ ci: update GitHub Actions │
92+ ├──────────┼──────────────────────────────┼────────────────────────────────┤
93+ │ chore │ Miscellaneous tasks │ chore: update .gitignore │
94+ ├──────────┼──────────────────────────────┼────────────────────────────────┤
95+ │ revert │ Revert previous commit │ revert: feat: old feature │
96+ └──────────┴──────────────────────────────┴────────────────────────────────┘
97+ Length Limits
98+
99+ - Header (first line): Max 100 characters
100+ - Body/Footer lines: Max 100 characters per line
101+
102+ Required Rules
103+ ┌────────────────────────────────────────────────────────┬─────────────────────┬────────────────────────┐
104+ │ Invalid │ Valid │ Reason │
105+ ├────────────────────────────────────────────────────────┼─────────────────────┼────────────────────────┤
106+ │ : some message │ fix: some message │ Type required │
107+ ├────────────────────────────────────────────────────────┼─────────────────────┼────────────────────────┤
108+ │ fix: │ fix: some message │ Subject required │
109+ ├────────────────────────────────────────────────────────┼─────────────────────┼────────────────────────┤
110+ │ FIX: message │ fix: message │ Type must be lowercase │
111+ ├────────────────────────────────────────────────────────┼─────────────────────┼────────────────────────┤
112+ │ foo: message │ feat: message │ Type not in list │
113+ ├────────────────────────────────────────────────────────┼─────────────────────┼────────────────────────┤
114+ │ feat: very long message exceeding 100 characters limit │ feat: short message │ Header too long │
115+ └────────────────────────────────────────────────────────┴─────────────────────┴────────────────────────┘
116+ Multi-line Format
117+
118+ ## Correct (blank line before body or footer)
119+ fix: resolve authentication bug
120+
121+ The login token was not being validated properly.
122+
123+ Closes #123
124+
125+ ## Warning (missing blank line)
126+ fix: resolve authentication bug
127+ The login token was not being validated properly.
0 commit comments