diff --git a/README.md b/README.md index de20dd796..1e3191598 100644 --- a/README.md +++ b/README.md @@ -396,7 +396,8 @@ the right to use your contribution. For details, visit https://cla.opensource.mi When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions -provided by the bot. You will only need to do this once across all repos using our CLA. +provided by the bot. You will only need to do this once across all repos using our CLA. Here are some +[code standards](docs/developer/code_standard.rst) when you submit a pull request. This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or diff --git a/docs/developer/code_standard.rst b/docs/developer/code_standard.rst new file mode 100644 index 000000000..23ea713ba --- /dev/null +++ b/docs/developer/code_standard.rst @@ -0,0 +1,20 @@ +.. _code_standard: + +================================= +Code Standard +================================= + +Docstring +================================= +Please use the Numpy Style. + +Continuous Integration +================================= +Continuous Integration (CI) tools help you stick to the quality standards by running tests every time you push a new commit and reporting the results to a pull request. + +A common error is the mixed use of space and tab. You can fix the bug by inputing the following code in the command line. + +.. code-block:: python + + pip install black + python -m black . -l 120 \ No newline at end of file