docs: update README with new deployment steps and reorganize contribution guide#24
Closed
akaBoyLovesToCode wants to merge 2 commits intoembyplus:mainfrom
akaBoyLovesToCode:main
Closed
docs: update README with new deployment steps and reorganize contribution guide#24akaBoyLovesToCode wants to merge 2 commits intoembyplus:mainfrom akaBoyLovesToCode:main
akaBoyLovesToCode wants to merge 2 commits intoembyplus:mainfrom
akaBoyLovesToCode:main
Conversation
…ibution guide - Replaced `pip` with `uv` for deployment and added `uv sync` and `uv run` commands for environment setup and bot execution - Enhanced README layout with improved clarity and formatting - Added English version of the README - Moved the contribution guide to `CONTRIBUTING.md` for better organization - Added badges for various services such as license, Python version, code quality, and ruff
## Sourcery 评审者指南
此 Pull Request 使用 `uv` 更新了 README 中的新部署步骤，并将贡献指南重组到一个单独的文件中。它还增强了 README 的布局，并添加了项目指标的徽章。
#### 新部署步骤的流程图
```mermaid
graph LR
A[克隆仓库] --> B(复制并编辑环境变量文件)
B --> C{使用 uv sync 同步依赖环境}
C --> D{使用 uv run app.py 运行机器人}文件级别变更
提示和命令与 Sourcery 互动
自定义您的体验访问您的 仪表板 以：
获取帮助Original review guide in EnglishReviewer's Guide by SourceryThis pull request updates the README with new deployment steps using Flow diagram for the new deployment stepsgraph LR
A[Clone the repository] --> B(Copy and edit the environment variables file)
B --> C{Sync dependency environment using uv sync}
C --> D{Run the bot using uv run app.py}
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
嘿 @Qubbby - 我已经查看了你的更改 - 这里有一些反馈：
总体评论：
- 考虑在 README 中添加目录，以便更轻松地导航。
- README 徽章看起来很棒，但考虑按逻辑对它们进行分组（例如，代码质量、项目状态）。
以下是我在审查期间查看的内容
- 🟡 一般问题：发现 2 个问题
- 🟢 安全性：一切看起来都不错
- 🟢 测试：一切看起来都不错
- 🟢 复杂性：一切看起来都不错
- 🟢 文档：一切看起来都不错
帮助我更有用！请在每条评论上点击 👍 或 👎，我将使用反馈来改进你的评论。
Original comment in English
Hey @Qubbby - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a table of contents to the README for easier navigation.
- The README badges look great, but consider grouping them logically (e.g., code quality, project status).
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| <img src="https://codecov.io/gh/embyplus/embyBot/branch/master/graph/badge.svg" alt="codecov"/> | ||
| </a> | ||
| <br /> | ||
| <a bref="https://github.com/astral-sh/ruff"> |
There was a problem hiding this comment.
issue (typo): 错别字："bref" 应该为 "href"
Suggested change
| <a bref="https://github.com/astral-sh/ruff"> | |
| <a href="https://github.com/astral-sh/ruff"> |
Original comment in English
issue (typo): Typo: "bref" should be "href"
Suggested change
| <a bref="https://github.com/astral-sh/ruff"> | |
| <a href="https://github.com/astral-sh/ruff"> |
Comment on lines
+117
to
+119
| ## 🎡 Activities | ||
|
|
||
|  |
There was a problem hiding this comment.
suggestion: 改进 "Activities" 部分
"Activities" 部分不清楚。请提供更多上下文并解释所指的活动。考虑将 Repobeats 分析链接移动到更合适的部分，例如 "Analytics" 或 "Code Quality" 中。
Original comment in English
suggestion: Improve "Activities" section
The "Activities" section is unclear. Provide more context and explain what activities are being referred to. Consider moving the Repobeats analytics link to a more appropriate section, such as "Analytics" or within "Code Quality".
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
1 participant
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.
This PR includes two documentation-related changes:
Update README Content:
pipwithuvcommands (uv syncanduv run) for environment setup and bot execution.CONTRIBUTING.mdfile for better organization.These updates aim to streamline the deployment process and improve the documentation structure, making it more user-friendly and maintainable.
好的，这是翻译成中文的 pull request 总结：
Sourcery 提供的总结
更新 README 中的部署说明以使用
uv，并创建一个新的 CONTRIBUTING.md 文件。文档：
uv命令代替pip的新部署说明。CONTRIBUTING.md文件。CONTRIBUTING.md中创建一个贡献指南，其中包含提交消息、数据库和 API 更改、pull request 的指南，以及支持的提交类型列表。Original summary in English
Summary by Sourcery
Update the deployment instructions in the README to use
uvand create a new CONTRIBUTING.md file.Documentation:
uvcommands instead ofpip.CONTRIBUTING.mdfile.CONTRIBUTING.mdwith guidelines for commit messages, database and API changes, pull requests, and a list of supported commit types