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 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: diff --git a/doc/release/release_dev.txt b/doc/release/release_dev.txt new file mode 100644 index 00000000..1123eb77 --- /dev/null +++ b/doc/release/release_dev.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 +------------ + + 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 +------------ + +