Hi all.
Recently it was brought to my attention that there is a dead link [1] in our documentation (commit message guidelines [2]). After having a look and asking around it turned out that it currently points to the old wiki which is finally offline, hence the dead link. I have created a patch to re-write the old content from the wiki in [3].
So far this is more or less a rewrite of what has been there in the old wiki with some additions from me. One review comment is that the mentioned limits for the line length of the first commit message might not be sufficient anymore. There it stated that the first line should be less than 65 characters or absolute maximum 75.
Shall we adjust this length now that we are having this commit message guideline available again in our docs? Limiting to a too low number might lead to struggles when writing a meaningful description with the prefixed file path. Having too big numbers here might make it hard to read on consoles and even in Gerrit. Any thoughts on the new limits? Or are the ones mentioned there still fine? Your input is valuable.
Thanks Werner
[1] https://www.coreboot.org/Git#Commit_messages [2] https://doc.coreboot.org/contributing/gerrit_guidelines.html#recommendations -for-gerrit-activity [3] https://review.coreboot.org/c/coreboot/+/85915
Sorry for the badly formatted link [2], it should have been
https://doc.coreboot.org/contributing/gerrit_guidelines.html#recommendations -for-gerrit-activity
Werner
Hi all.
Recently it was brought to my attention that there is a dead link [1] in
our
documentation (commit message guidelines [2]). After having a look and asking around it turned out that it currently
points
to the old wiki which is finally offline, hence the dead link. I have created a patch to re-write the old content from the wiki in [3].
So far this is more or less a rewrite of what has been there in the old
wiki
with some additions from me. One review comment is that the mentioned limits for the line length of the first commit message might not be sufficient anymore. There it stated that the first line should be less than 65 characters or absolute maximum 75.
Shall we adjust this length now that we are having this commit message guideline available again in our docs? Limiting to a too low number might lead to struggles when writing a meaningful description with the prefixed file path. Having too big numbers here might make it hard to read on consoles and
even
in Gerrit. Any thoughts on the new limits? Or are the ones mentioned there still
fine?
Your input is valuable.
Thanks Werner
https://doc.coreboot.org/contributing/gerrit_guidelines.html#recommendations
-for-gerrit-activity [3] https://review.coreboot.org/c/coreboot/+/85915
Thanks Werner!
On 9. Jan 2025, at 16:47, Zeh, Werner via coreboot coreboot@coreboot.org wrote:
Sorry for the badly formatted link [2], it should have been
https://doc.coreboot.org/contributing/gerrit_guidelines.html#recommendations -for-gerrit-activity
Werner
Hi all.
Recently it was brought to my attention that there is a dead link [1] in
our
documentation (commit message guidelines [2]). After having a look and asking around it turned out that it currently
points
to the old wiki which is finally offline, hence the dead link. I have created a patch to re-write the old content from the wiki in [3].
So far this is more or less a rewrite of what has been there in the old
wiki
with some additions from me. One review comment is that the mentioned limits for the line length of the first commit message might not be sufficient anymore. There it stated that the first line should be less than 65 characters or absolute maximum 75.
Shall we adjust this length now that we are having this commit message guideline available again in our docs? Limiting to a too low number might lead to struggles when writing a meaningful description with the prefixed file path. Having too big numbers here might make it hard to read on consoles and
even
in Gerrit. Any thoughts on the new limits? Or are the ones mentioned there still
fine?
Your input is valuable.
Thanks Werner
https://doc.coreboot.org/contributing/gerrit_guidelines.html#recommendations
-for-gerrit-activity [3] https://review.coreboot.org/c/coreboot/+/85915
_______________________________________________ coreboot mailing list -- coreboot@coreboot.org To unsubscribe send an email to coreboot-leave@coreboot.org
-
LEAN SHENG TAN -
Zeh, Werner