diff --git a/.moban.d/README.rst b/.moban.d/README.rst index daed7f0..a1d6c79 100644 --- a/.moban.d/README.rst +++ b/.moban.d/README.rst @@ -18,3 +18,8 @@ Known Issues * If a zero was typed in a DATE formatted field in xls, you will get "01/01/1900". * If a zero was typed in a TIME formatted field in xls, you will get "00:00:00". {%endblock%} + +Developer guide +================== + +{%include 'developer_guide.rst.jj2' %} diff --git a/.travis.yml b/.travis.yml index 900b332..7d7d158 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,6 +13,7 @@ python: before_install: - pip install https://github.com/pyexcel/pyexcel-io/archive/master.zip - pip install https://github.com/pyexcel/pyexcel/archive/master.zip + - pip install -r rnd_requirements.txt - pip install -r tests/requirements.txt script: make test diff --git a/README.rst b/README.rst index 8558403..6850fc8 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,31 @@ +Development steps for code changes + +#. git clone https://github.com/pyexcel/pyexcel-xls.git +#. cd pyexcel-xls +#. pip install -r requirements.txt +#. pip install -r tests/requirements.txt + + +In order to update test envrionment, and documentation, additional setps are +required: + +#. pip install moban +#. git clone https://github.com/pyexcel/pyexel-commons.git +#. make your changes in `.moban.d` directory, then issue command `moban` + + +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 test + +On Windows systems, please issue this command:: + + > test.bat ================================================================================ pyexcel-xls - Let you focus on data, instead of xls format ================================================================================