ElapsingDreams/LiteyukiBot
1
0
Fork 0
forked from LiteyukiStudio/LiteyukiBot
Code Pull Requests Activity

📝 新增开发规范

Browse Source
This commit is contained in:
snowykami 2024-09-01 10:35:54 +08:00
parent 49a15d512e
commit ee1ae5a071
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/en/dev/guide.md
View File

@ -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 type hints in the code are correct.
- Ensure that the comment style is [`Google Docstring`](https://google.github.io/styleguide/pyguide.html) or - 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. [`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). - 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: - 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. - You should commit the code after completing a feature or fixing a bug, and not mix the code of multiple features or bugs together.