• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
  • Campbell Ritchie
  • Ron McLeod
  • Tim Cooke
  • Liutauras Vilda
  • Jeanne Boyarsky
  • Paul Clapham
  • Rob Spoor
  • Junilu Lacar
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Piet Souris
  • Carey Brown

Git commit messages and PR titles

Saloon Keeper
Posts: 14662
  • Likes 1
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
It's important that developers can quickly see what they will be changing about their code when they merge a commit. I'm pleased with the detail of the commit messages, but remember that the first line of the message should be a clear summary of the changes.

Convention is to start the commit message with an imperative. It should look like an instruction of what to do with the current code, for instance: "Add logger to Card class".

The same goes for pull request titles. I believe GitHub uses the commit message of the last commit you made when you made the pull request, but you can edit this to give a more appropriate summary of the changes you intend to merge.
    Bookmark Topic Watch Topic
  • New Topic