Page MenuHomePhabricator

Add prefixes to commits to improve their readability?
Closed, ResolvedPublic

Description

This task is not about the problems of Phabricator, it's about design of commits :) Just a small suggestion on formalization of commits.

In out project we use prefixes for every commit. As a result, our commits have the following form:

[{type}.{moduleName}] {desc}

Fox example, in you Phabricator project, you commit may have this message:

[fix.diffusion] displaying messages in summary T15

Types of commits:

  • feat (new feature)
  • fix (bugfixes)
  • docs (writing documentation, adding commetns to sources, etc)
  • ref (refactoring)
  • chore (not particularly important, maintain commits)
  • you own type of commit?

These prefixes allow more quickly analyze the history of commits and find those commits which relate to a specific module of project. Maybe you also have to taste similar style of commits.

Related Objects

Event Timeline

If your developers are already doing this today, what's the feature request? See Contributing Feature Requests for what we look for in requests. Mostly, it sounds like your company has a local process already for this. I haven't heard of any other install with a similar process, so I don't think in general it something that should be brought upstream.

Its just suggestion as i say, mabye you deems it useful for yourself. Sorry if i written about it in wrong place, just wanted to give you a useful application for improving the convenience in your work)

chad claimed this task.

No worries! Z1336: General Chat is a great place to join and chat with the community if you're inclined.