Skip to content

Instantly share code, notes, and snippets.

@joshbuchea
Last active October 29, 2024 20:59
Show Gist options
  • Save joshbuchea/6f47e86d2510bce28f8e7f42ae84c716 to your computer and use it in GitHub Desktop.
Save joshbuchea/6f47e86d2510bce28f8e7f42ae84c716 to your computer and use it in GitHub Desktop.
Semantic Commit Messages

Semantic Commit Messages

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

References:

@uncenter
Copy link

To remove a commented code, which one should I use? Chore or Style? Or another?

I would use chore or refactor, i.e. chore: remove unnecessary comments or refactor: clean up code comments.

@phcoliveira
Copy link

Perhaps a lint: would also be useful.
I am including a new ESLint rule to an old codebase.
For the moment, most changes will be about adding ignoring comments for errors which can not be fixed automatically.
But even for the ones that can be fixed automatically I think lint: is a nice prefix.

@marijoo
Copy link

marijoo commented Oct 19, 2023

Perhaps a lint: would also be useful.
I am including a new ESLint rule to an old codebase.
For the moment, most changes will be about adding ignoring comments for errors which can not be fixed automatically.
But even for the ones that can be fixed automatically I think lint: is a nice prefix.

Use chore: since your changes won‘t affect the build.

@martin-braun
Copy link

@phcoliveira The idea of semantic commit messages is that you don't have many options, hence you can pick it properly without much complexity.

@JoaoGH @uncenter chore should be the right one when removing comments. refactor only when you change symbol names, style only when reformatting (removing comments is not part of reformatting).

@oscarwiding
Copy link

What would you use for removing an old / deprecated code ?

@martin-braun
Copy link

@oscarwiding I would personally go for chore (or chore! if it was public API), but only if the new implementation was committed separately. If your commit removes old code and adds new code, it's rather feat or fix (depending what the new code does in relation to the old) or in rare cases refactor (when only deprecating old symbol names and introducing new ones).

I'm looking for feedback by others though, but that's how I would approach the situation.

@zheng655
Copy link

那你子涵吗名字步步惊心不

@cn-2k
Copy link

cn-2k commented Jan 10, 2024

Which type can I use to commit a dependency update? I see the build(deps): type often, is it correct?

@uncenter
Copy link

I use chore: bump deps even though that's probably wrong. build: bump deps makes sense, I'm not sure if the scope of deps that you have in the example build(deps): works though...

@mrkhairullah
Copy link

If I install tailwindcss and setup the main.css file, then what type should I use? chore(package)?

@uncenter
Copy link

uncenter commented Jan 30, 2024

@mrkhairullah What kind of repository is this? Is it a web application? A documentation site? A monorepo? You need context. It might be refactor(docs): switch to tailwindcss (a repo with a docs/ folder), feat: use tailwindcss (a repo that is just for a website), etc.

@marijoo
Copy link

marijoo commented Jan 30, 2024

@mrkhairullah If you are importing tailwindcss inside main.css for the first time and your application is using this css file, this will most likely impact your app, so I’d go with feat since it is not a fix and I would expect a new version tag for this.

@mrkhairullah
Copy link

mrkhairullah commented Jan 30, 2024

@mrkhairullah What kind of repository is this? Is it a web application? A documentation site? A monorepo? You need context. It might be refactor(docs): switch to tailwindcss (a repo with a docs/ folder), feat: use tailwindcss (a repo that is just for a website), etc.

@uncenter yep web app for personal web use react and vite. When adding tailwind in package.json is a chore? and when adding main.css to commit in git use refactor or feat?

@mrkhairullah
Copy link

@mrkhairullah If you are importing tailwindcss inside main.css for the first time and your application is using this css file, this will most likely impact your app, so I’d go with feat since it is not a fix and I would expect a new version tag for this.

okey thanks @marijoo

@showierdata9978
Copy link

Somthing i use when i do CI is

CI: Add eslint10

@septianhari
Copy link

useful sir

@Achmad96
Copy link

How about change the configuration?

@showierdata9978
Copy link

How about change the configuration?

chore prolly

@famdude
Copy link

famdude commented Apr 9, 2024

changing project structure, for example creating new src directory, and probably moving some filed into it, is in which type? docs, refactor, chore?

@uncenter
Copy link

uncenter commented Apr 9, 2024

changing project structure, for example creating new src directory, and probably moving some filed into it, is in which type? docs, refactor, chore?

I'd go with refactor.

@marijoo
Copy link

marijoo commented Apr 9, 2024

changing project structure, for example creating new src directory, and probably moving some filed into it, is in which type? docs, refactor, chore?

I'd go with refactor.

Depends. If it‘s a package and the changed project structure eventually impacts users, it could also be a breaking change which should be reflected in a version.

@famdude
Copy link

famdude commented Apr 11, 2024

changing project structure, for example creating new src directory, and probably moving some filed into it, is in which type? docs, refactor, chore?

I'd go with refactor.

Depends. If it‘s a package and the changed project structure eventually impacts users, it could also be a breaking change which should be reflected in a version.

No visible change for users is made

@LakshmanKishore
Copy link

Thanks!

@LucaMalisan
Copy link

LucaMalisan commented Apr 23, 2024

What'd you suggest to use if I remove a feature?
If it caused bugs, it would be bugfix I guess. But what if it was just unnecessary?

@uncenter
Copy link

What'd you suggest to use if I remove a feature? If it caused bugs, it would be bugfix I guess. But what if it was just unnecessary?

bugfix isn't a conventional commit type, it would be fix. That also could be considered something breaking, so you can use an exclamation mark to mark it as such: fix!: xyz and remove abc feature.

@XxA7med66xX
Copy link

I learned something useful today, thanks!

@dogukancaner
Copy link

useful

@ayanchavand
Copy link

very cool

@rezzvy
Copy link

rezzvy commented Sep 2, 2024

Hi, if I add a new library like Bootstrap files to my project before creating the index.html, what tag should I use? I’ve been using 'chore' but it might be misleading. What do you think?

@showierdata9978
Copy link

feat: Include Libraries?

But I'd also just include them in the same commit with
feat: Initial Commit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment