doc/changelog.rst¶
Changelog must answer a question: What is changed, do I need those updates?
注解
Don’t use too technical description of the updates. For fixes, describe which error fixed, when the error happened, but without diving too much in technical details
Guidlines¶
`2.0.0`
-------
- **New:** absolutely new way of ..
`1.2.0`
-------
- **New:** new interface for ...
- **Improvement:** better way to do ...
`1.0.1`
-------
- **Fix:** issue about ...
- **Fix:** another issue about ...
`1.0.0`
-------
- **Init version**