conventional-commits / conventionalcommits.org

The conventional commits specification
https://conventionalcommits.org
MIT License
6.73k stars 520 forks source link

I think there are some bad examples in the portuguese version #457

Closed yudi-azvd closed 1 year ago

yudi-azvd commented 2 years ago

In the portuguese version of conventional commits, I think there are some bad examples like the following (link):

## Mensagem de commit com ! para chamar a atenção para quebra a compatibilidade

refactor!: remove suporte para Node 6

Which translates to

## Commit message with ! to draw attention to breaking change

refactor!: removes support for Node 6

Maybe this example is not adequate since refactoring means changing the internal structure without modifying observable behavior (Refactoring, Kent Beck). Refactor and breaking changes shouldn't be in the same commit/PR, right?

I'm no expert in software development or refactoring, I'm still learning things. So I'm if I understood something, please tell me :D

yudi-azvd commented 2 years ago

I've just read the summary and it says "a BREAKING CHANGE can be part of commits of any type".

Is this correct even for refactor: type? Can someone explain why?

Also, the reasoning presented in my previous comment was accepted in this PR.

javier-godoy commented 2 years ago

See #229

yudi-azvd commented 2 years ago

Ok... i've read it. Should I open a PR correcting it?

damianopetrungaro commented 2 years ago

Sure @yudi-azvd ! Feel free to open a PR suggesting a better example! Thanks for noticing it as well :D

yudi-azvd commented 2 years ago

Ok :D One more thing. When correcting, should I modify v1.0.0/index.pt-br.md or create a new doc in, say, v1.0.1/...?

yudi-azvd commented 2 years ago

@damianopetrungaro I don't know if you speak portuguese, but can you take a look at #458? Or maybe assign a reviewer who speaks portuguese

yudi-azvd commented 1 year ago

Closed by #458.