import{_ as e,c as t,o,a4 as i}from"./chunks/framework.BZiUP1E-.js";const m=JSON.parse('{"title":"Development Guide","description":"","frontmatter":{"title":"Development Guide","order":0},"headers":[],"relativePath":"en/dev/guide.md","filePath":"en/dev/guide.md","lastUpdated":1725150470000}'),a={name:"en/dev/guide.md"},n=i('Development Guide
How to Develop
Please read the Plugin Development and API Reference documents if you are developing a plugin.
If you need to submit code to the Liteyuki repository, please read the following:
- First fork a copy of the Liteyuki repository to your personal/organization account.
- Develop in your repository.
- Create a new branch in your repository and submit your code to this branch.
- Create a Pull Request in your repository to merge your branch into the
main branch of the Liteyuki repository.
- Participation in development assumes that you are already familiar with the basic usage of the Python language and the Liteyuki framework.
- If you are developing documentation, please ensure that you are familiar with Markdown syntax and basic front-end knowledge.
- Contact the repository maintainer in case of conflicts.
Suggestions
- During development, you can use tools such as
mypy, flake8, and black for code checking and formatting. - Enable developer mode by setting
dev_mode: true in config.yml to see more debugging information in the console.
Standardization
- Code should follow
PEP8 and Google Python Style Guide. - In addition, code submitted to the Liteyuki repository should follow the following guidelines:
- Ensure that the code is runnable and harmless.
- Ensure that the type hints in the code are correct.
- Ensure that the comment style is
Google Docstring or Liteyuki Docstring(recommended) to ensure that Litedoc can parse and generate documentation correctly. - If there is a part for ordinary users, ensure that the documentation is complete (each language has corresponding documentation).
- The documentation should follow
Markdown syntax and support vitepress-related content: - Revise the documentation for each language when editing.
- Ensure that the links in the document are correct and do not lead to inaccessible links.
- Ensure that the User Documentation is easy to understand and the Development Documentation is detailed.
Finally
- This project is a non-profit open-source project, and we welcome anyone to participate in development. Your contributions will make Liteyuki better.
',12),r=[n];function l(d,s,u,c,h,p){return o(),t("div",null,r)}const f=e(a,[["render",l]]);export{m as __pageData,f as default};