[RFC] Suggestion of minor change to patch submission policy re: long descriptions in commit headers

[Joshua Lock <josh@linux.intel.com>]

Our patch submission policy[1] 

"Optionally, you may include pointers to defects this change corrects.
Unless the defect format is specified by the component you are
modifying, it is suggested that you use a full URL to specify the
reference to the defect information. Generally these pointers will
precede any long description, but as an optional item it may be after
the long description."

I've been guilty of always having the defect id after the description,
and have never included the defect URL (though my reading suggests this
is not required for Yocto defects I still believe this will make the
defect id's more useful for fellow OE-Core developers).

Whilst I intend to rectify the latter I'd like to propose we change the
former such that the defect information is at the end of the commit
message.

I believe this is more suitable for the project because the defect
information and its relevance should be summarised in the long
description, and therefore the defect id and link to the defect tracker
are supplemental information for interested readers.

IMHO this supplementary nature should lead us to request submitters
provide defect information after the long description.

Thoughts?

Regards,
Joshua

1.
http://openembedded.org/index.php?title=Commit_Patch_Message_Guidelines#New_Development

-- 
Joshua Lock
        Yocto Project "Johannes factotum"
        Intel Open Source Technology Centre