I’ve seen some teams and projects having really nice CHANGELOG.md and release notes but knowing from experience, writing release notes by hand is a pain. Scrolling through git log, guessing which commits count as features or fixes, and hoping you don’t forget something important isn’t exactly fun.
All projects need a good README.md, It’s the front door to the project and it needs to quickly show a potential user what the tool does and why it’s valuable. I put a lot of effort in having a good README for tbdflow but it was still static text, and the examples was buried deep down.
When you publish a CLI tool on crates.io, you’ll often get a familiar question (at least I did):
Read more...I’ve received some great feedback since launching tbdflow: while the tool is powerful, the commands can be long to type, and it’s another set of flags to remember. This is a great point, the goal of any good CLI is to reduce friction, not add to it.