tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

produce better drafts for releases

Browse Source 
Introduce Changelog.draft.rst in the releasing process. Using a dedicated file
for the WIP gives more readable diffs.

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
This commit is contained in:
Nicolas Sebrecht 2011-01-19 20:13:38 +01:00
parent ab3caedf11
commit d9a72c30ba
2 changed files with 56 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
Changelog.draft.rst Normal file
View File

@ -0,0 +1,52 @@
=========
ChangeLog
=========
Users should ignore this content: **it is draft**.
Contributors should add entries here in the following section, on top of the
others.
`WIP (coming releases)`
=======================
New Features
------------
* Makefile learn to build the package and make it the default.
* Introduce a Changelog.
* Migrate documentation to restructuredtext.
Changes
-------
* Imply single threading mode in debug mode exept for "-d thread".
* Code and import cleanups.
* Allow UI to have arbitrary names.
* Code refactoring around UI and UIBase.
* Improve version managment and make it easier.
Bug Fixes
---------
* Fixes in README.
* Only verify hostname if we actually use CA cert.
* Remove uneeded files.
* Fix makefile clean for files having whitespaces.
* Fix makefile to not remove unrelated files.
* Introduce a true single threading mode.
* Fix 'Ctrl+C' interruptions in threads.
* Fix ssl ca-cert in the sample configuration file.
Pending for the next major release
==================================
* UIs get shorter and nicer names. (API changing)
Stalled
=======
* Learn Sqlite support.
Stalled: it would need to learn the ability to choose between the current
format and SQL to help testing the long term.

52
Changelog.rst
View File

@ -3,56 +3,12 @@ ChangeLog
========= =========
**NOTE FROM THE MAINTAINER:** **NOTE FROM THE MAINTAINER:**
Contributors should use the `WIP` section in order to add changes they are Contributors should use the `WIP` section in Changelog.draft.rst in order to
working on. I will use it to make the new changelog entry on releases. And add changes they are working on. I will use it to make the new changelog entry
because I'm lazy, it will also be used as a draft for the releases announces. on releases. And because I'm lazy, it will also be used as a draft for the
Users should skip the `WIP` section: **it is a draft**. releases announces.
`WIP (coming releases)`
=======================
.. Contributors should add entries here in the approppriate subsection, on top.
New Features
------------
* Makefile learn to build the package and make it the default.
* Introduce a Changelog.
* Migrate documentation to restructuredtext.
* UIs get shorter and nicer names.
Pending until next major release.
* Learn Sqlite support.
Stalled: it would need to learn the ability to choose between the current
format and SQL to help testing the long term.
Changes
-------
* Imply single threading mode in debug mode exept for "-d thread".
* Code and import cleanups.
* Allow UI to have arbitrary names.
* Code refactoring around UI and UIBase.
* Improve version managment and make it easier.
Bug Fixes
---------
* Fixes in README.
* Only verify hostname if we actually use CA cert.
* Remove uneeded files.
* Fix makefile clean for files having whitespaces.
* Fix makefile to not remove unrelated files.
* Introduce a true single threading mode.
* Fix 'Ctrl+C' interruptions in threads.
* Fix ssl ca-cert in the sample configuration file.
.. Here comes history on what we did.
OfflineIMAP v6.3.2-rc1 (2010-12-19) OfflineIMAP v6.3.2-rc1 (2010-12-19)
=================================== ===================================