doc: add commit message guidelines to the dev guide #18657
Conversation
There was a problem hiding this comment.
What about using (we already did in the past, but reverted) https://github.com/FRRouting/frr/blob/master/.github/commitlint.config.js?
doc/developer/workflow.rst
Outdated
|
|
||
| - Must be no more than 72 characters | ||
| - Must be a complete sentnce that can be used when generating the release changelog |
There was a problem hiding this comment.
maybe the real emphasis should be on a meaningful statement that can be used at release time to help produce a changelog. you could even say "help the release managers out ..." !
There was a problem hiding this comment.
I added a couple more bullet points to make this clearer.
doc/developer/workflow.rst
Outdated
|
|
||
| - Must be separted from the tille by a blank line. | ||
| - Must be Wrapped to 72 characters, unless it is a sample output. | ||
| - Wrap sample output with a code format block (3 tickes line before and after) |
There was a problem hiding this comment.
maybe "markdown syntax code block"
and "ticks" ?
Jafaral
force-pushed
the
commit-msg-format
branch
2 times, most recently
from
facb860 to
eae21c5
Compare
Yes, I did see this and I think we should re-enable it once we settle on the formatting rules. |
Jafaral
force-pushed
the
commit-msg-format
branch
from
eae21c5 to
3bb2a11
Compare
Jafaral
force-pushed
the
commit-msg-format
branch
3 times, most recently
from
401d1ee to
fc4cbf5
Compare
Signed-off-by: Jafar Al-Gharaibeh <[email protected]>
Jafaral
force-pushed
the
commit-msg-format
branch
from
fc4cbf5 to
5d49e40
Compare
|
rendered here |
No description provided.