Qlib dev doc (microsoft#1142)

AIGeniusInstitute · Jun 21, 2022 · a87b026 · a87b026
1 parent da676a2
commit a87b026
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -458,7 +458,7 @@ Before we released Qlib as an open-source project on Github in Sep 2020, Qlib is
 
 This project welcomes contributions and suggestions.  
 **Here are some 
-[code standards](docs/developer/code_standard.rst) for submiting a pull request.**
+[code standards and development guidance](docs/developer/code_standard_and_dev_guide.rst) for submiting a pull request.**
 
 Making contributions is not a hard thing. Solving an issue(maybe just answering a question raised in [issues list](https://github.com/microsoft/qlib/issues) or [gitter](https://gitter.im/Microsoft/qlib)), fixing/issuing a bug, improving the documents and even fixing a typo are important contributions to Qlib.
 

diff --git a/docs/developer/code_standard.rst → ...developer/code_standard_and_dev_guide.rst b/docs/developer/code_standard.rst → ...developer/code_standard_and_dev_guide.rst
@@ -45,4 +45,16 @@ When you submit a PR request, you can check whether your code passes the CI test
 .. code-block:: bash
 
     pip install -e .[dev]
-    pre-commit install
+    pre-commit install
+
+
+=================================
+Development Guidance
+=================================
+
+As a developer, you often want make changes to `Qlib` and hope it would reflect directly in your environment without reinstalling it. You can install `Qlib` in editable mode with following command.
+The `[dev]` option will help you to install some related packages when developing `Qlib` (e.g. pytest, sphinx)
+
+.. code-block:: bash
+
+    pip install -e .[dev]