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
Original file line number
Diff line number
Diff line change
@@ -246,19 +246,39 @@ Then install relevant development requirements:
246
246
#. pip install -r requirements.txt
247
247
#. pip install -r tests/requirements.txt
248
248
249
+
Once you have finished your changes, please provide test case(s), relevant documentation
250
+
and update CHANGELOG.rst.
249
251
250
-
In order to update test environment, and documentation, additional steps are
251
-
required:
252
+
.. note::
253
+
254
+
As to rnd_requirements.txt, usually, it is created when a dependent
255
+
library is not released. Once the dependecy is installed
256
+
(will be released), the future
257
+
version of the dependency in the requirements.txt will be valid.
258
+
259
+
260
+
How to test your contribution
261
+
------------------------------
262
+
263
+
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.
264
+
265
+
On Linux/Unix systems, please launch your tests like this::
266
+
267
+
$ make
268
+
269
+
On Windows systems, please issue this command::
270
+
271
+
> test.bat
272
+
273
+
How to update test environment and update documentation
#. make your changes in `.moban.d` directory, then issue command `moban`
256
281
257
-
What is rnd_requirements.txt
258
-
-------------------------------
259
-
260
-
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.
261
-
262
282
What is pyexcel-commons
263
283
---------------------------------
264
284
@@ -269,18 +289,15 @@ What is .moban.d
269
289
270
290
`.moban.d` stores the specific meta data for the library.
271
291
272
-
How to test your contribution
273
-
------------------------------
274
-
275
-
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.
276
-
277
-
On Linux/Unix systems, please launch your tests like this::
292
+
Acceptance criteria
293
+
-------------------
278
294
279
-
$ make
295
+
#. Has Test cases written
296
+
#. Has all code lines tested
297
+
#. Passes all Travis CI builds
298
+
#. Has fair amount of documentation if your change is complex
0 commit comments