Git-point: Commit message conventions

Created on 1 Aug 2017  路  11Comments  路  Source: gitpoint/git-point

discussion

Most helpful comment

Nothing will happen, probably (unless you need to do some big rebasing). Just use the style in your PR title and everything should work fine.

All 11 comments

All for it! My personal format is just in a sentence, present-tense, imperative-style. For example, I do Change this feature instead of changed this feature.

In bigger projects, though, I can definitely see the need for more detailed commits including change type. I really like https://github.com/marionebl/commitlint but I'm not a fan of the other one because of the enforced emojis in commit titles.

Along with this, we might also want to setup some versioning conventions. There are quite a few questions that arise around this. When should we release new patch/minor/major updates? Should we consider any change that would require an iOS update "major"? Should all these be immediately pushed to the device using CodePush, or should we exclude all major updates?

We need to discuss this, including versioning conventions. I suggest also to add a new label - under discussions.

Interesting points indeed. I'm all for a convention on commit messages. We should also consider a issue/pr template file.

_Definitely_ for this.

Okay so I think we're all on board to have:

  1. A commit convention. How can we enforce this? Or can we just include it into our contributing guidelines for newer contributors?
  2. Versioning conventions is definitely something we need to consider. Again, we'll need to keep in mind CodePush can't take care of native code updates, so maybe we can revolve major updates around that?
  3. Definitely down for issue/PR templates. I'm okay with not having an issue one but I think a PR template will be extremely useful.

If no one gets to it - I'll open issues for 2. and 3. soon and leave this thread as discussion for commit conventions.

@housseindjirdeh I've contributed to repos with pre-commit hooks that enforce the commit style. I'd like to see how we could do that.

@andrewda awesome :) I was just wondering if that could be done with commit hooks - definitely think it would be great to have!

So we follow the format of the commits messages, as in Angular, do I understand correctly? Although I'm not familiar with this, but let's try :+1:

@lex111 it's the style Google uses on almost all their repos and it works pretty well!

Now we need to do releases and in fact we have 0 releases.

I'm working on the issue #5 and I already did some commits without this style :innocent:
What's going to happen?

Nothing will happen, probably (unless you need to do some big rebasing). Just use the style in your PR title and everything should work fine.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

housseindjirdeh picture housseindjirdeh  路  5Comments

alejandronanez picture alejandronanez  路  5Comments

umarmughal picture umarmughal  路  4Comments

andrewda picture andrewda  路  4Comments

machour picture machour  路  3Comments