Skip to content

Commit a18b2ac

Browse files
committed
update documentation
1 parent 5fc745a commit a18b2ac

File tree

4 files changed

+38
-20
lines changed

4 files changed

+38
-20
lines changed

README.rst

Lines changed: 34 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -136,19 +136,39 @@ Then install relevant development requirements:
136136
#. pip install -r requirements.txt
137137
#. pip install -r tests/requirements.txt
138138

139+
Once you have finished your changes, please provide test case(s), relevant documentation
140+
and update CHANGELOG.rst.
139141

140-
In order to update test environment, and documentation, additional steps are
141-
required:
142+
.. note::
143+
144+
As to rnd_requirements.txt, usually, it is created when a dependent
145+
library is not released. Once the dependecy is installed
146+
(will be released), the future
147+
version of the dependency in the requirements.txt will be valid.
148+
149+
150+
How to test your contribution
151+
------------------------------
152+
153+
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.
154+
155+
On Linux/Unix systems, please launch your tests like this::
156+
157+
$ make
158+
159+
On Windows systems, please issue this command::
160+
161+
> test.bat
162+
163+
How to update test environment and update documentation
164+
---------------------------------------------------------
165+
166+
Additional steps are required:
142167

143168
#. pip install moban
144169
#. git clone https://github.com/pyexcel/pyexcel-commons.git commons
145170
#. make your changes in `.moban.d` directory, then issue command `moban`
146171

147-
What is rnd_requirements.txt
148-
-------------------------------
149-
150-
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.
151-
152172
What is pyexcel-commons
153173
---------------------------------
154174

@@ -159,18 +179,15 @@ What is .moban.d
159179

160180
`.moban.d` stores the specific meta data for the library.
161181

162-
How to test your contribution
163-
------------------------------
164-
165-
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.
166-
167-
On Linux/Unix systems, please launch your tests like this::
182+
Acceptance criteria
183+
-------------------
168184

169-
$ make
185+
#. Has Test cases written
186+
#. Has all code lines tested
187+
#. Passes all Travis CI builds
188+
#. Has fair amount of documentation if your change is complex
189+
#. Agree on NEW BSD License for your contribution
170190

171-
On Windows systems, please issue this command::
172-
173-
> test.bat
174191

175192

176193
License

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
project = u'pyexcel-io'
2424
copyright = u'2015-2017 Onni Software Ltd.'
2525
version = '0.4.0'
26-
release = '0.4.0'
26+
release = '0.4.1'
2727
exclude_patterns = []
2828
pygments_style = 'sphinx'
2929
html_theme = 'default'

pyexcel_io.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
overrides: "pyexcel.yaml"
22
name: "pyexcel-io"
33
nick_name: io
4-
version: 0.4.0
4+
version: 0.4.1
5+
current_version: 0.4.1
56
release: 0.4.0
67
dependencies:
78
- ordereddict;python_version<"2.7"

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
NAME = 'pyexcel-io'
1212
AUTHOR = 'C.W.'
13-
VERSION = '0.4.0'
13+
VERSION = '0.4.1'
1414
EMAIL = 'wangc_2011@hotmail.com'
1515
LICENSE = 'New BSD'
1616
DESCRIPTION = (

0 commit comments

Comments
 (0)