commit-template.txt 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. # topic[/subtopic]: Short description which should finish before char 72
  2. #
  3. # [Optional general description of the changeset goes here. See below for
  4. # further guidance. A short description of each specific change
  5. # made:]
  6. #
  7. # * <file>: (function/typemacro) type of change
  8. # * <file>: (func_{a,b,c}) Frobnicated to match the foo.
  9. # * <file>: (foo_{bar,war}) Ditto.
  10. # * <file>: (fnar_*) Ditto, and also twiddled for the thing.
  11. # Guidelines:
  12. #
  13. # - Set your editor to 72 char line width (so 'git log' fits in 80
  14. # chars).
  15. #
  16. # The 'topic' is used to collate the commit logs, to create summaries
  17. # for release announcements, so please provide one.
  18. #
  19. # Often the topic is the name of the daemon affected (e.g. 'bgpd' or
  20. # 'ospfd'), or 'lib', or 'build'. The subtopic isn't often used, but
  21. # 'security' is a good one to provide on security fixes.
  22. #
  23. # The body should provide:
  24. #
  25. # - The motivation for the change (does it fix a bug, if so which?
  26. # add a feature?)
  27. #
  28. # - The general approach taken, and trade-offs versus any other
  29. # approaches.
  30. #
  31. # - Any testing undertaken or other information affecting the
  32. # confidence that can be had in the change.
  33. #
  34. # - Information to allow reviewers to be able to tell which
  35. # specific changes to the code are intended (and hence be able
  36. # to spot any accidental unintended changes).
  37. #
  38. # - The commit message *must* give details of all the authors of the change,
  39. # beyond the person listed in the Author field. Any and all
  40. # affiliations which may have a bearing on copyright in any way
  41. # should be clearly stated, unless those affiliations are already
  42. # obvious from other details, e.g. from the email address. This
  43. # would cover employment and contracting obligations (give
  44. # details).
  45. #
  46. # Note: Do not rely on "Signed-off-by" for this, be explicit.
  47. #
  48. # - If the change introduces a new dependency on any code or other
  49. # copyrighted material, please explicitly note this. Give details
  50. # of what that external material is, the copyright licence the
  51. # material may be used under, and the nature of the dependency.
  52. #
  53. # Please have a look at the git commit logs to get a feel for what the
  54. # norms are.