add development guide

This commit is contained in:
chfw 2016-05-03 08:31:13 +01:00
parent 669bc64261
commit 823197acf9
3 changed files with 34 additions and 0 deletions

View File

@ -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' %}

View File

@ -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

View File

@ -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
================================================================================