scientific-python / changelist

Prepare an automatic changelog from GitHub pull requests
BSD 3-Clause "New" or "Revised" License
8 stars 4 forks source link

Make README intro more succinct #54

Closed stefanv closed 9 months ago

stefanv commented 9 months ago

New users / developers often scan a README to figure out what a package does and whether they need it. This PR aims to reduce the amount of upfront text, focusing on the key characteristics of the package.

I've removed the text about release notes not being perfect because (a) developers know they can edit release notes and (b) probably also know that they shouldn't spend much time doing that ;)

lagru commented 9 months ago

Thanks!