Commit message template

Hi,

I search around, and could not find a plugin or any other info in regards to this, so here we go.
Basically, we are a team of ~6 people working on a PHP project.
We just recently moved to PhpStorm, and we like it so far.

What we also came up with was a standard for commit messages, to get a) a better understanding of the changes made, and b) to create a better meaningfull changelog.
We use Grunt and some plugins to accomplish this.

So here is what we are using at the moment, and what seems to be almost a standard for other project:

Each commit message starts with a type, a scope, and a subject.
Below that, the commit message has a body.

  • type: what type of change this commit contains.
  • scope: what item of code this commit is changing.
  • subject: a short description of the changes.
  • body (optional): a more in-depth description of the changes
<type>(<scope>): <subject>
<BLANK LINE>
<body>


Type

  • feat: A new feature
  • fix: A bug fix
  • wip: While working on a fix/feature
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug or adds a feature
  • test: Adding missing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation


And scope is also a list, which depends on our project, for example forum, news, ...


So what we are looking for is a feature within the commit dialog, where we can add/create a commit message template.
Add dropdowns with values from type and scope, add them to the template as placeholder.

I was not able to find a plugin to do this, and I'm not sure it is possible to do with a plugin, as this would involve to temper with the PhpStorm core.
Does anyone else came across this, or maybe even a plugin who can do this?
If not, is this something which can be added to PhpStorm?

Many thanks,
Christian

4 comments
Comment actions Permalink

There is no such feature currently, please vote for: https://youtrack.jetbrains.com/issue/IDEA-66355

0
Comment actions Permalink

I opened a Ticket for this, and it has been marked as a duplicate on the one you just mentioned.

https://youtrack.jetbrains.com/issue/WI-26384

However, I don't see why.
I'm not looking for an implementation to use a git command commit template, but a commit template system inside PhpStorm.
There might be references, but in the end are 2 seperate issues.

0
Comment actions Permalink

Not sure if you're still waiting for this or not, but I created a new plugin to create a message template:

https://plugins.jetbrains.com/idea/plugin/9364-commit-message-template

0
Comment actions Permalink

Matan,

Nice plugin :)  

Take a look at commitizen,  it has the template patterns that you are looking for as well as others.  It might be a nice tool to integrate into the git system.

0

Please sign in to leave a comment.