Description unclear about cargo-semver-checks HOT 5 OPEN

Hi, thanks for the suggestion! Short descriptions are always a struggle between keeping it short and being clear and precise, and I find it quite hard to write them 😅

Unfortunately, the proposed tweak is too long. The best one-liner descriptions are generally 10 words or fewer. Any ideas that could fit in that size range?

from cargo-semver-checks.

I'd say if your project's concept isn't trivial, don't be stubborn on some arbitrary limit.
However you're right it should be shorter. As "semver" is already in the name, how about simply "Ensure crate minor revisions introduce no breaking changes" ?

from cargo-semver-checks.

Interesting direction. Perhaps something along the lines of "Avoid accidental breaking changes ..." or "Catch accidental breaking changes ..."?

Not sure what the second half should be, feels like it should be something like "before " or "without " but I can't figure out the exact words to put there. Any ideas?

Thanks for workshopping this with me! Names are hard, short taglines and descriptions are even harder 😅

from cargo-semver-checks.

How about just a small tweak to the original by adding the word accidental (I think it helps ppl realize it's not something they did wrong on purpose). I think the name of the tool is already very descriptive so the one liner doesn't have that much work to do. So it would become:

Lint your crate API changes for accidental semver violations

from cargo-semver-checks.

After some subconscious reflection I'm not sure adding accidental adds value. It might be more confusing than useful.

from cargo-semver-checks.