cz-cli VS software-development

Adopt a convention like commitizen: https://github.com/commitizen/cz-cli

'typeofchange(scopeofchange): reason for change'

It sort helps force devs to type out more meaningful commit messages.

Commitizen Define a interface to write your commits and automatically and a prefix and a suffix to your message. (and others features not related)

Conventional commits are great, especially if you add in commit linting.

Being able to programmatically increment semantic versions and automatically generate relevant changelogs is awesome.

It’s also nice to implement Commitizen[0] for a little hand holding until folks get used to the linting.

I used to care a lot about doing things the way that felt right to me, but now I just want some common standard that is easy for everyone to follow, easy to automate, and easy to verify programmatically.

Things like conventional commits and semantic versioning aren’t perfect, but they are quite good and apply broadly to many use cases with common tooling and conventions.

--

[0]: http://commitizen.github.io/cz-cli/

In the world of software development, maintaining consistent code quality and ensuring that the codebase adheres to predefined patterns and guidelines is crucial. However, manually enforcing these standards can be time-consuming and error-prone. This is where automation tools like Husky, Lint-Staged, Commitlint, and Commitizen come to the rescue. In this post, we will explore how these tools can be combined to streamline your development workflow.

Conventional commits specification contains a set of rules for creating an explicit commit history, which makes it easier to write automated tools on top of, for example, semantic release. You can manually follow this convention in your project or use a tool to assist you, such as Commitizen.

When working with JavaScript projects, managing version numbers and commit messages is important for the maintainability of the project. Since 2020 I have been the main developer of Atomic Calendar Revive a highly customisable Home Assistant calendar card, I found maintaining versions and releases to be cumbersome until recently. In this article, I will introduce the commitizen and semantic-release packages for creation or appropriate commit messages and semantic versioning. I will also provide examples of how I am currently using these packages to streamline my release workflow and project maintenance.

I use Commitizen to enforce a strict commit message. It's not required - but it makes my life easier. It adheres to a standard - but it's certainly not "the" standard.

When I googled, I found cz-cli project first: https://github.com/commitizen/cz-cli

Same thing with git commits. Something like commitizen. It forces a specific format of your commits. And if you're using an associated issue/bug tracker that can automatically link to commits you can set up to format like that.

That may also serve as a good entry point for nodeJS via the tools: commitizen, commitLint. That is you implement them within your project, and then also think about how to implement via CI/CD remotely.

Totally agree that it has lost its meaning. We call things “incomplete work” that are, well, incomplete work.

https://github.com/aaronjensen/software-development/blob/mas...

sbellware may have more to add, but there isn't a name for it. We focus more on the "it" than the branding of it. We do use the word "continuity" to describe our goal: https://github.com/aaronjensen/software-development/blob/mas...

> The words "equipment log" and "work product" sound pretty unique.

We call them "material logs", as equipment logs are more or less a subset of those. Just think about the sheet in every bathroom at a store that says when it was last cleaned, or the clipboard attached to the factory machine that lists its maintenance record and problems. Or the patient record outside of the patient's door.

"work product" just means, the product of our work. Nothing special about that one, I don't think.

> Are Erl's SOA books and Yourdon's on OOP still relevant?

I haven't read either, personally, though I have Yourdon's book en route. We use the term "structural design" quite a bit, so I'm curious to see Yourdon's take on what they call "structured design". From everything I've read about it, it sounds very similar to a lot of how we think about things as it seems to be the basis for much of the coupling and cohesion thought in our industry.

I'd also recommend studying Lean (not Lean Startup, which has much to do with Lean as non-fat yogurt does).

There’s another way that feels totally unnatural at first, but puts the subject (the most important part) of the commit message first. It makes the commit about the change and the code, rather than the author. This is how we do it in all of our projects. I fought it at first, but I was wrong and it’s a lot better.

Example:

EntityStore build method records the specifier argument when given

Article about it: https://github.com/aaronjensen/software-development/blob/mas...