Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(practices): add commit message practices #440

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

nksazonov
Copy link
Contributor

No description provided.

- **fix**: A bug fix
- **docs**: Documentation only changes
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- **refact**: A code change that neither fixes a bug nor adds a feature
Copy link
Contributor

@maxpushka maxpushka Oct 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about using full word refactor here instead of contracted refact? Further in the doc in Tools section commitizen is mentioned; it would be great to use default configuration instead of making each team member keep track of what has changes in the config, follow breaking changes in the tool itself (e.g., config format).

Having a config at all would enable us to add even more entries to it in the future "in case we need it" – it would be great to avoid creating such bureaucracy pitfall. Sure it's easy to add a config entry, but it would increase complexity of onboarding the team to the practice by creating an additional step.

There's a great article by Loris Cro, Zig core maintainer, that breaks down the "simple-hard vs trivial-complex" dichotomy. Putting it in terms of the article, we want our practice to be trivial (in terms of complexity) and not just easy (in terms of effort). Speaking in terms of Golang and Python philosophy, no config and opinionated defaults are better since less is more.

Copy link
Contributor Author

@nksazonov nksazonov Oct 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... it would be great to avoid creating such bureaucracy pitfall.

... we want our practice to be trivial and not <just> easy.

I agree here. As always it comes down to: on one hand we have features (an ability to enforce some custom rules), while on the other the efforts needed to implement a such a system that could be (almost) effortlessly enforced locally among all team members. The hand that brings more value should win.

We need to estimate what are other possible features of enforcing a custom rule set, otherwise than "we just have custom rules". For now, we can indeed proceed with a custom config.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants