liuyu/qlib
1
0
Fork 0
mirror of https://github.com/microsoft/qlib.git synced 2026-06-06 05:51:17 +08:00
Code Activity

Qlib dev doc (#1142)

Browse Source
This commit is contained in:
you-n-g
2022-06-21 09:46:30 +08:00
committed by GitHub
parent da676a20a2
commit a87b02619a
2 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

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

14
docs/developer/code_standard.rst → docs/developer/code_standard_and_dev_guide.rst
View File

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