From e74ba1b4f006fe9959a27916f0a2caf84078478e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Wed, 11 Jun 2014 07:22:10 -0400 Subject: [PATCH 1/7] Add release note instructions --- RELEASE.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/RELEASE.txt b/RELEASE.txt index b56b5bb8..de90a580 100644 --- a/RELEASE.txt +++ b/RELEASE.txt @@ -8,6 +8,10 @@ How to make a new release of ``skimage`` - To show a list of contributors and changes, run ``doc/release/contribs.py ``. + - Review and cleanup ``doc/release/release_dev.txt``, rename to + ``doc/release/release_X.txt``, and create new + ``doc/release/release_dev.txt``. + - Update the version number in ``setup.py`` and ``bento.info`` and commit - Update the docs: From c3b4e589786d5c82009a27b8281dcef54ecf2cf6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Wed, 11 Jun 2014 07:28:48 -0400 Subject: [PATCH 2/7] Describe new release note dev process For upcoming contributions, every contributor should document the contributed changes, before merging the PR. --- CONTRIBUTING.txt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt index 202210a1..837dca2a 100644 --- a/CONTRIBUTING.txt +++ b/CONTRIBUTING.txt @@ -77,6 +77,12 @@ For a more detailed discussion, read these :doc:`detailed documents Travis fails, you can find out why by clicking on the "failed" icon (red cross) and inspecting the build and test log. +5. Document changes + + Before merging your commits, you must add a description of your changes + to the release notes of the upcoming version in + ``doc/release/release_dev.txt``. + .. note:: To reviewers: if it is not obvious, add a short explanation of what a branch @@ -85,7 +91,7 @@ For a more detailed discussion, read these :doc:`detailed documents Divergence between ``upstream master`` and your feature branch -.............................................................. +-------------------------------------------------------------- Do *not* ever merge the main branch into yours. If GitHub indicates that the branch of your Pull Request can no longer be merged automatically, rebase From 4235e8a448883d673d3927c584e38194150bc7b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Wed, 11 Jun 2014 07:55:48 -0400 Subject: [PATCH 3/7] Add release notes for upcoming versions --- doc/release/release_dev.txt | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 doc/release/release_dev.txt diff --git a/doc/release/release_dev.txt b/doc/release/release_dev.txt new file mode 100644 index 00000000..9503b7e7 --- /dev/null +++ b/doc/release/release_dev.txt @@ -0,0 +1,35 @@ +Announcement: scikit-image 0.X.0 +================================ + +New Features +------------ + + + + +Improvements +------------ + + + + +Changes +------- + + + + +Deprecations +------------ + + + + +Contributors to this release +---------------------------- + +This release was made possible by the collaborative efforts of many +contributors, both new and old. They are listed in alphabetical order by +surname: + + From 5d4ec15fd597996b2b912f7360867cee869a55b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Sun, 15 Jun 2014 08:29:55 -0400 Subject: [PATCH 4/7] Remove contributors for current release notes --- doc/release/release_dev.txt | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/doc/release/release_dev.txt b/doc/release/release_dev.txt index 9503b7e7..da8c2b07 100644 --- a/doc/release/release_dev.txt +++ b/doc/release/release_dev.txt @@ -23,13 +23,3 @@ Deprecations ------------ - - -Contributors to this release ----------------------------- - -This release was made possible by the collaborative efforts of many -contributors, both new and old. They are listed in alphabetical order by -surname: - - From be3ac9a14181d0da29b9e06444b8ad56edfe38e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Mon, 4 Aug 2014 21:15:47 -0400 Subject: [PATCH 5/7] Rename Changes section to API changes --- doc/release/release_dev.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/release/release_dev.txt b/doc/release/release_dev.txt index da8c2b07..00d34ac3 100644 --- a/doc/release/release_dev.txt +++ b/doc/release/release_dev.txt @@ -13,8 +13,8 @@ Improvements -Changes -------- +API Changes +----------- From 8ef53d04f069be082cffb675d04e471f74a4388f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Mon, 4 Aug 2014 22:01:10 -0400 Subject: [PATCH 6/7] Add intro to release notes --- doc/release/release_dev.txt | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/release/release_dev.txt b/doc/release/release_dev.txt index 00d34ac3..1123eb77 100644 --- a/doc/release/release_dev.txt +++ b/doc/release/release_dev.txt @@ -1,6 +1,17 @@ Announcement: scikit-image 0.X.0 ================================ +We're happy to announce the release of scikit-image v0.X.0! + +scikit-image is an image processing toolbox for SciPy that includes algorithms +for segmentation, geometric transformations, color space manipulation, +analysis, filtering, morphology, feature detection, and more. + +For more information, examples, and documentation, please visit our website: + +http://scikit-image.org + + New Features ------------ From c3b79ca6781f0b7b438677675e0837d3c29e0e0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Mon, 4 Aug 2014 22:01:40 -0400 Subject: [PATCH 7/7] Add release notes template --- doc/release/release_template.txt | 36 ++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 doc/release/release_template.txt diff --git a/doc/release/release_template.txt b/doc/release/release_template.txt new file mode 100644 index 00000000..1123eb77 --- /dev/null +++ b/doc/release/release_template.txt @@ -0,0 +1,36 @@ +Announcement: scikit-image 0.X.0 +================================ + +We're happy to announce the release of scikit-image v0.X.0! + +scikit-image is an image processing toolbox for SciPy that includes algorithms +for segmentation, geometric transformations, color space manipulation, +analysis, filtering, morphology, feature detection, and more. + +For more information, examples, and documentation, please visit our website: + +http://scikit-image.org + + +New Features +------------ + + + + +Improvements +------------ + + + + +API Changes +----------- + + + + +Deprecations +------------ + +