Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41.94%. Comparing base (5f3a3d0) to head (fb840b8).
Report is 2 commits behind head on main.

@@           Coverage Diff           @@
##             main    #1051   +/-   ##
=======================================
  Coverage   41.94%   41.94%           
=======================================
  Files          21       21           
  Lines        1786     1786           
=======================================
  Hits          749      749           
  Misses       1037     1037           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Hello, good catch!

Docs were inconsistent and gave errors when copy and pasting.

What kind of errors did you get? Normally using either of git-cliff or git cliff would work, as long as you have git installed in your system (which I assume so).

I agree that there might be inconsistencies in the docs and we should fix them. It's a matter of which style we want to go for I guess :)

Arh ok, I've mostly run in through npx git-cliff directly, where it certainly doesn't work without the dash. :)

Ah, certainly. Both forms of git-cliff and git cliff would work on the CLI but npx should call git-cliff explicitly. Maybe we can add a note to https://git-cliff.org/docs/installation/npm instead of updating the other parts of the documentation?

Sure, it's your decision at the end of the day. :)

Just wanted to help out and make it more consistant, as many of the examples that uses both syntaxes looks like typos.
And since git-cliff is the only one that works cross all environments I would vouch for that one.

I personally like the git cliff usage, since it's more aligned with the rest of the git commands. (e.g. git status, git log, etc.)

Instead of updating usages, I'd prefer we add a note about:

1. git-cliff is the correct invocation, however calling git cliff is also possible when git is installed.
2. When using npx, git-cliff should be used.

Would you be down to update this PR based on this? 😊

Cool, I respect that. Yes, will update the PR. Great tool btw! 🙌

Great, thank you <3 Ping me whenever this is ready for a review :)

I've reverted to minor changes. 😊 Should be ready now.

Congrats on merging your first pull request! ⛰️