Rules for Commit Messages

Gedare Bloom gedare at rtems.org
Wed Feb 10 15:38:28 UTC 2021


https://devel.rtems.org/wiki/Developer/Git#GitCommits

On Wed, Feb 10, 2021 at 8:06 AM Joel Sherrill <joel at rtems.org> wrote:
>
> Hi
>
> I was looking for guidance on how we write a commit message to provide it to someone. Unfortunately, I don't see it in the Software Engineering Guide although I admit I could have missed it.
>
> I assume it would be something like this:
>
> [area|file]: Brief description
>
> Longer description hopefully giving a but of insight.
>
> [ [closes|updates] #NNN.]
>
> Commit message should be more useful than "fix bug" and give a solid indication in the title which part of RTEMS it applies to. Specific file, test, etc.or a functional area like a filesystem or scheduler.
>
> Am I missing something?
>
> --joel
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel


More information about the devel mailing list