📚 update developer guide and PR guide

pyexcel · Dec 28, 2019 · 90c1cd2 · 90c1cd2
1 parent 7b13399
commit 90c1cd2
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,6 +2,8 @@ With your PR, here is a check list:
 
 - [ ] Has Test cases written
 - [ ] Has all code lines tested
+- [ ] Has `make format` been run?
+- [ ] Has `moban` been run?
 - [ ] Passes all Travis CI builds
 - [ ] Has fair amount of documentation if your change is complex
 - [ ] run 'make format' so as to confirm the pyexcel organisation's coding style

diff --git a/README.rst b/README.rst
@@ -353,18 +353,27 @@ On Windows systems, please issue this command::
 
     > test.bat
 
-How to update test environment and update documentation
+
+Before you commit
+------------------------------
+
+Please run::
+
+    $ make format
+
+so as to beautify your code otherwise travis-ci may fail your unit test.
+
+
+And make sure you would have run moban command
 ---------------------------------------------------------
 
 Additional steps are required:
 
 #. pip install moban
 #. make your changes in `.moban.d` directory, then issue command `moban`
+#. moban
 
-What is pyexcel-commons
----------------------------------
-
-Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in `pyexcel-commons` project.
+otherwise travis-ci may also fail your unit test.
 
 What is .moban.d
 ---------------------------------