Documentation | Clarify commit message header "tags" (#132)

[Amar Takhar (@amar)]

Amar Takhar commented: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/132#note_140113


In my experience these are useless for CI for a few reason and it also taints history:

* Source moves around.
* People will inconsistency decide which directory to use, is it based on how many files in the subdir?  The "biggest change to source" or the phase of the moon.
* It forces us to iterate changes more for those who don't conform.
* Adding a CI check to make sure these are right is impossible.

This is why the CI check is just for the colon.  The utility of even having anything in front is to give a vague idea of what the change is.  Also since you say the first one is a directory.. what about when it's the README.  So someone uses readme: that means.. what? `/readme/` .. `readme` `readme.*` .. what does it mean?

I'd like to leave it the wild west that it is and maybe have a restriction on length, 15? 20? chars max?  We can enforce that using CI.

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/132#note_140113
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20260127/a16cafd5/attachment.htm>