Skip to content

Commit 1f06189

Browse files
committed
update developer guide
1 parent da40a5c commit 1f06189

File tree

1 file changed

+26
-19
lines changed

1 file changed

+26
-19
lines changed

Diff for: README.rst

+26-19
Original file line numberDiff line numberDiff line change
@@ -220,28 +220,16 @@ Then install relevant development requirements:
220220
#. pip install -r requirements.txt
221221
#. pip install -r tests/requirements.txt
222222

223+
Once you have finished your changes, please provide test case(s), relevant documentation
224+
and update CHANGELOG.rst.
223225

224-
In order to update test environment, and documentation, additional steps are
225-
required:
226+
.. note::
226227

227-
#. pip install moban
228-
#. git clone https://github.com/pyexcel/pyexcel-commons.git commons
229-
#. make your changes in `.moban.d` directory, then issue command `moban`
230-
231-
What is rnd_requirements.txt
232-
-------------------------------
228+
As to rnd_requirements.txt, usually, it is created when a dependent
229+
library is not released. Once the dependecy is installed
230+
(will be released), the future
231+
version of the dependency in the requirements.txt will be valid.
233232

234-
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.
235-
236-
What is pyexcel-commons
237-
---------------------------------
238-
239-
Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in `pyexcel-commons` project.
240-
241-
What is .moban.d
242-
---------------------------------
243-
244-
`.moban.d` stores the specific meta data for the library.
245233

246234
How to test your contribution
247235
------------------------------
@@ -256,6 +244,25 @@ On Windows systems, please issue this command::
256244

257245
> test.bat
258246

247+
How to update test environment and update documentation
248+
---------------------------------------------------------
249+
250+
Additional steps are required:
251+
252+
#. pip install moban
253+
#. git clone https://github.com/pyexcel/pyexcel-commons.git commons
254+
#. make your changes in `.moban.d` directory, then issue command `moban`
255+
256+
What is pyexcel-commons
257+
---------------------------------
258+
259+
Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in `pyexcel-commons` project.
260+
261+
What is .moban.d
262+
---------------------------------
263+
264+
`.moban.d` stores the specific meta data for the library.
265+
259266
Acceptance criteria
260267
-------------------
261268

0 commit comments

Comments
 (0)