chore: modernizing project structure & CI#155
Open
mangodxd wants to merge 1 commit intoythx-101:mainfrom
Open
Conversation
ythx-101
reviewed
Apr 7, 2026
Owner
ythx-101
left a comment
There was a problem hiding this comment.
APPROVE
此 PR 为项目添加了基础配置文件,整体质量良好。以下是具体分析:
新增文件概述:
.editorconfig:统一编辑器格式配置,设置空格缩进(4格)和 UTF-8 编码,合理。CONTRIBUTING.md:贡献指南,提示安装pre-commit。SECURITY.md:安全政策,指示通过邮件报告漏洞。pyproject.toml:项目构建与工具配置。
潜在问题(不阻塞合并):
-
项目名称可疑:
pyproject.toml中name = "tmpt7gekwh_"看起来像是自动生成的临时名称,建议改为实际项目名称。 -
ruff配置位置错误:select字段应放在[tool.ruff.lint]下(Ruff v0.1.0+ 的规范),直接写在[tool.ruff]下已被废弃:[tool.ruff.lint] select = ["E", "F", "I", "UP", "B", "SIM", "PTH"]
-
文件末尾缺少换行:
CONTRIBUTING.md和SECURITY.md缺少末尾换行(\ No newline at end of file),与.editorconfig的规范不一致,建议修复。 -
SECURITY.md 信息不完整:仅说"通过邮件报告",但未提供具体邮件地址,对贡献者实用性较低。
-
black与ruff格式化重复:同时配置两者可能引起冲突,建议明确只用其中一个作为格式化工具。
整体而言,这是一个良好的项目初始化 PR,上述问题均属于小瑕疵,不影响功能。
|
这个方向很实用!补充几点建议: 建议
有兴趣可以参考 OpenClaw 主仓库的 CI 配置:https://github.com/openclaw/...(具体路径忘了,应该在 .github/workflows 下) 整体支持 👍 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Modernizing project structure & ci 🚀
Hi! I'm a big fan of automation, so I put together a small suite of tools to help catch bugs and keep the code clean.
What's inside?
pyproject.toml(the modern PEP 621 way) to keep configs in one place.Why?
Modern tooling like
ruffandpyproject.tomlmakes the project much easier to maintain and more welcoming for new contributors. Plus, having a CI/CD safety net is always a win.These are purely infrastructure-focused and won't touch any of your actual logic. Let me know what you think!
Pulled with ❤️ by me (ofc).