Skip to content

Commit 369872c

Browse files
committed
fix #39: ugly and working instructions are better than nothing
1 parent 70d1716 commit 369872c

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

templates/developer_guide.rst.jj2

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Development steps for code changes
2+
3+
#. git clone https://github.com/pyexcel/{{name}}.git
4+
#. cd {{name}}
5+
#. pip install -r requirements.txt
6+
#. pip install -r tests/requirements.txt
7+
8+
9+
In order to update test envrionment, and documentation, additional setps are
10+
required:
11+
12+
#. pip install -r moban
13+
#. git clone https://github.com/pyexcel/pyexel-commons.git
14+
#. make your changes in `.moban.d` directory, then do `moban`
15+
16+
17+
How to test your contribution
18+
------------------------------
19+
20+
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.
21+
22+
On Linux/Unix systems, please launch your tests like this::
23+
24+
$ make test
25+
26+
On Windows systems, please issue this command::
27+
28+
> test.bat
29+

0 commit comments

Comments
 (0)