update documentation

pyexcel · Jun 28, 2017 · a18b2ac · a18b2ac
1 parent 5fc745a
commit a18b2ac
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 20 deletions.
diff --git a/README.rst b/README.rst
@@ -136,19 +136,39 @@ Then install relevant development requirements:
 #. pip install -r requirements.txt
 #. pip install -r tests/requirements.txt
 
+Once you have finished your changes, please provide test case(s), relevant documentation
+and update CHANGELOG.rst.
 
-In order to update test environment, and documentation, additional steps are
-required:
+.. note::
+
+    As to rnd_requirements.txt, usually, it is created when a dependent
+	library is not released. Once the dependecy is installed
+	(will be released), the future
+	version of the dependency in the requirements.txt will be valid.
+
+
+How to test your contribution
+------------------------------
+
+Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
+
+On Linux/Unix systems, please launch your tests like this::
+
+    $ make
+
+On Windows systems, please issue this command::
+
+    > test.bat
+
+How to update test environment and update documentation
+---------------------------------------------------------
+
+Additional steps are required:
 
 #. pip install moban
 #. git clone https://github.com/pyexcel/pyexcel-commons.git commons
 #. make your changes in `.moban.d` directory, then issue command `moban`
 
-What is rnd_requirements.txt
--------------------------------
-
-Usually, it is created when a dependent library is not released. Once the dependecy is installed(will be released), the future version of the dependency in the requirements.txt will be valid.
-
 What is pyexcel-commons
 ---------------------------------
 
@@ -159,18 +179,15 @@ What is .moban.d
 
 `.moban.d` stores the specific meta data for the library.
 
-How to test your contribution
-------------------------------
-
-Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
-
-On Linux/Unix systems, please launch your tests like this::
+Acceptance criteria
+-------------------
 
-    $ make
+#. Has Test cases written
+#. Has all code lines tested
+#. Passes all Travis CI builds
+#. Has fair amount of documentation if your change is complex
+#. Agree on NEW BSD License for your contribution
 
-On Windows systems, please issue this command::
-
-    > test.bat
 
 
 License

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -23,7 +23,7 @@
 project = u'pyexcel-io'
 copyright = u'2015-2017 Onni Software Ltd.'
 version = '0.4.0'
-release = '0.4.0'
+release = '0.4.1'
 exclude_patterns = []
 pygments_style = 'sphinx'
 html_theme = 'default'

diff --git a/pyexcel_io.yaml b/pyexcel_io.yaml
@@ -1,7 +1,8 @@
 overrides: "pyexcel.yaml"
 name: "pyexcel-io"
 nick_name: io
-version: 0.4.0
+version: 0.4.1
+current_version: 0.4.1
 release: 0.4.0
 dependencies:
   - ordereddict;python_version<"2.7"

diff --git a/setup.py b/setup.py
@@ -10,7 +10,7 @@
 
 NAME = 'pyexcel-io'
 AUTHOR = 'C.W.'
-VERSION = '0.4.0'
+VERSION = '0.4.1'
 EMAIL = 'wangc_2011@hotmail.com'
 LICENSE = 'New BSD'
 DESCRIPTION = (