faker icon indicating copy to clipboard operation
faker copied to clipboard

add "locale" as a possible semantic pull request type

Open matthewmayer opened this issue 1 year ago • 8 comments
trafficstars

It is a locale PR. So I would love a locale(module): nomenclature. Until then it is I'm fine with either of those.

Originally posted by @ST-DDT in https://github.com/faker-js/faker/issues/3173#issuecomment-2409028242

matthewmayer avatar Oct 13 '24 15:10 matthewmayer

This would be used when just adding or removing locale data in a pull request e.g. https://github.com/faker-js/faker/pull/3173 https://github.com/faker-js/faker/pull/3154 https://github.com/faker-js/faker/pull/3142

Would this simply be a matter of adding locale in

https://github.com/faker-js/faker/blob/next/.github/workflows/semantic-pull-request.yml

?

matthewmayer avatar Oct 13 '24 15:10 matthewmayer

Would this simply be a matter of adding locale in

No it wont, and it would even conflict with the current infra setup of producing separate sections for Changelog

e.g. https://github.com/faker-js/faker/blob/next/CHANGELOG.md#new-locales

Shinigami92 avatar Oct 14 '24 07:10 Shinigami92

We could change it here:

  • https://github.com/faker-js/faker/blob/next/.versionrc.json

ST-DDT avatar Oct 14 '24 07:10 ST-DDT

Could we first discuss why the one is better than the other?

Right now we are sure what a fix and what a feat is This has effect not only of incrementing the minor or biggie number, but also separate between updated and new locales

The module or locale (e.g. de) is also written into the commit message

Updating this process required also a search through the current contribution guide, so we do not forget something to update

My personal though is currently to not touch this process, but I'm by far not the only maintainer and maybe there is a benefit that I currently don't see

Shinigami92 avatar Oct 14 '24 08:10 Shinigami92

My point of contention is, that we use the locale label, but the feat/refactor prefix. Only for fixes we use both.

ST-DDT avatar Oct 14 '24 08:10 ST-DDT

I'm not too bothered whether we add a new label or not, maybe it's just a question of updating the documentation to make it clearer which one to pick?

matthewmayer avatar Oct 14 '24 08:10 matthewmayer

Ah now I see the refactor(vehicle): add more non-US vehicle manufacturers because only src/locales/en/vehicle/manufacturer.ts were effectively touched for the outside-consumer, it should have been a refactor(locale): add more non-US vehicle manufacturers and as you can see, the vehicle was already in the commit message and don't need to be addressed in commit scope a second time

But it is merged already 🤷, so better luck next time

Shinigami92 avatar Oct 14 '24 12:10 Shinigami92

Refactors which add new data to existing locales seem different to refactors which actually change code (but don't change the output). But maybe it's fine to call them both refactor.

matthewmayer avatar Oct 14 '24 13:10 matthewmayer

Team Decision

  • We will keep it as is for v9.x

ST-DDT avatar Oct 26 '24 14:10 ST-DDT