From ee1ae5a071717089b69a27e6e97c0c0795eaa0a6 Mon Sep 17 00:00:00 2001 From: snowykami Date: Sun, 1 Sep 2024 10:35:54 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20=E6=96=B0=E5=A2=9E=E5=BC=80=E5=8F=91?= =?UTF-8?q?=E8=A7=84=E8=8C=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/dev/guide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/en/dev/guide.md b/docs/en/dev/guide.md index f504b9cf..8f3b92da 100644 --- a/docs/en/dev/guide.md +++ b/docs/en/dev/guide.md @@ -47,6 +47,7 @@ The `src` directory is the application part, please develop business logic in th - Ensure that the type hints in the code are correct. - Ensure that the comment style is [`Google Docstring`](https://google.github.io/styleguide/pyguide.html) or [`Liteyuki Docstring`](https://github.com/LiteyukiStudio/litedoc?tab=readme-ov-file#liteyuki-docstring)(recommended) to ensure that Litedoc can parse and generate documentation correctly. + - Strings should be enclosed in double quotes `"` as much as possible, and single quotes `'` should be used when nesting strings. - If there is a part for ordinary users, ensure that the documentation is complete (each language has corresponding documentation). - commit message should follow the following guidelines: - You should commit the code after completing a feature or fixing a bug, and not mix the code of multiple features or bugs together.