-
Couldn't load subscription status.
- Fork 75
Description
📝 Issue 内容(中文版)
📌 建议
为了提升项目的代码质量和开发效率,建议将以下事项归为一个子项目,由社区成员共同讨论并执行:
编码规范:针对 AI 编程工具设置全局记忆,确保一致性和可维护性。
格式整理:为开发者推荐代码格式化工具,并在 GitHub 增加自动规范功能,例如 pre-commit + ruff 以保持代码风格一致。
文档规范:推荐使用 mintlify 插件集成至 IDE,推广开发者共同使用 mintlify 进行文档管理,以增强可读性和协作效率。
包管理:推荐统一的包管理工具(如 Poetry 或 pip-tools),并规范 requirements.txt 或 pyproject.toml 以简化依赖管理。
环境创建:为 Windows、macOS 和 Linux 平台提供标准化的工具安装指南、目录结构、环境配置方案,以及 IDE 调试文件推荐。
📢 讨论计划
第一阶段(Phase 1):社区成员共同讨论项目计划,明确目标。
第二阶段(Phase 2):定义标准,并编写相关文档。
第三阶段(Phase 3):所有成员共同执行,优化开发流程。
希望大家参与讨论,提供建议,并帮助推动这个子项目的实施!💡🚀
📝 Issue Content (English Version)
📌 Proposal
To improve code quality and development efficiency, we propose forming a subproject where community members can collectively discuss and execute the following tasks:
Code Standards: Set up global memory configurations for AI coding tools to ensure consistency and maintainability.
Formatting Rules: Recommend code formatting tools for developers and integrate automated enforcement in GitHub, using solutions like pre-commit + ruff to maintain style consistency.
Documentation Standards: Recommend using the mintlify plugin in IDEs, promoting its adoption for structured documentation to enhance readability and collaboration.
Package Management: Establish a standardized approach to package management (Poetry, pip-tools), ensuring a clean dependency definition through requirements.txt or pyproject.toml.
Environment Setup: Provide guidelines for Windows, macOS, and Linux, covering tool installation, directory structure, environment configuration, and recommended IDE debugging files.
📢 Discussion Plan
Phase 1: Community members collaborate to define project objectives.
Phase 2: Establish standards and draft related documentation.
Phase 3: Collective execution and optimization of workflows.
We welcome everyone to participate, provide insights, and help drive this subproject forward! 💡🚀