You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+34-17Lines changed: 34 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -136,19 +136,39 @@ Then install relevant development requirements:
136
136
#. pip install -r requirements.txt
137
137
#. pip install -r tests/requirements.txt
138
138
139
+
Once you have finished your changes, please provide test case(s), relevant documentation
140
+
and update CHANGELOG.rst.
139
141
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
#. make your changes in `.moban.d` directory, then issue command `moban`
146
171
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
-
152
172
What is pyexcel-commons
153
173
---------------------------------
154
174
@@ -159,18 +179,15 @@ What is .moban.d
159
179
160
180
`.moban.d` stores the specific meta data for the library.
161
181
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
+
-------------------
168
184
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
0 commit comments