From 64e6a92f5d6e94b2e45d1adf61e4045c1eabea0c Mon Sep 17 00:00:00 2001 From: Valentin Haenel Date: Tue, 7 Feb 2012 22:38:26 +0100 Subject: [PATCH] [docs/RF] adapte the maintainers notes to reflect new naming --- doc-src/CONTRIBUTING.rst | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/doc-src/CONTRIBUTING.rst b/doc-src/CONTRIBUTING.rst index 85c6c29..8c2f9bc 100644 --- a/doc-src/CONTRIBUTING.rst +++ b/doc-src/CONTRIBUTING.rst @@ -222,9 +222,9 @@ installation simply type:: make -You can then run: +You can then run:: ->>> import pypsignifit as psi + >>> import pypsignifit as psi from the source directory. Furthermore you can use the environment variable ``PYTHONPATH`` in case you need to bring source directory into scope elsewhere @@ -234,30 +234,33 @@ Maintainers Notes ----------------- This section contains notes about the release process. We also support this -process with various ``Makefile`` targets. Since Psignift 3.x is still beta +process with various ``Makefile`` targets. All targets for release are prefixed +with ``dist-`` + +Since Psignift 3.x is still beta software we provide so called development snapshots as and when new features and bugfixes are available. Development Snapshots ..................... -Development snapshots are made on a regular basis. They consist of the following steps +Development snapshots are made on a regular basis. They are invoked with:: + + make dist-upload-archives -* make a changelog entry -* create a tarball. The tarball should be named as - ``psignifit3.0_beta_DD-MM-YYYY.tar.gz`` -* create a tag in the git repository. The tag for a snapshot should be - ``snap-YYYY-MM-DD`` -* upload the tarball to sourceforge (into a new folder!) -* push tags +This will create all the required zip files and windows installers, tag the git +repository, and upload the files and tags to sourceforge. Tags .... Tags should mark critical points in the development history in the following way: -* ``snap-YYYY-MM-DD`` marks the release of a development snapshot -* ``doc-YYYY-MM-DD`` marks a modification of the documentation that has been uploaded to sourceforge. +* ``release/3.0_beta.YYYYMMDD.1`` marks the release of a development snapshot +* ``doc-YYYYMMDD`` marks a modification of the documentation that has been uploaded to sourceforge. + +Older tags may have different versioning schemes. This scheme was established +beginning of 2012. Extending ---------