Revise README for XEngineer branding and content - #75
Conversation
Updated the README to reflect the new branding and project focus on XEngineer, including changes to the introduction, project goals, and course details. Signed-off-by: Nliver <34496563+Nliver@users.noreply.github.com>
Nliver
added
documentation
There was a problem hiding this comment.
⚠️ Not ready to approve
The updated README contains invalid HTML nesting in the header block and an inaccurate repository license statement that should be corrected for reliable rendering and clarity.
Pull request overview
This PR refreshes the repository’s README.md to reflect the new XEngineer branding and updated positioning/content, including revised program philosophy, milestones, and contribution workflow.
Changes:
- Replaced the old TechCamp/1024 实训营 README header and introduction with new XEngineer branding and messaging.
- Added/updated sections describing the program’s capability model, milestone journey, and engineering guidelines.
- Updated contributing guidance and the license section copy.
File summaries
| File | Description |
|---|---|
| README.md | Rewrites README content and structure to align with XEngineer branding, program framing, and contribution guidance. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Low
Note
Your feedback helps us improve the quality of this feature.
Please use 👍 or 👎 to tell us whether this assessment is correct.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![fennoai[bot]](https://avatars.githubusercontent.com/in/1924301?s=60&v=4){kind=small}
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nliver <34496563+Nliver@users.noreply.github.com>
There was a problem hiding this comment.
⚠️ Not ready to approve
There are documentation inconsistencies/inaccuracies (milestone count mismatch and repo license statement) that should be corrected before merging.
Review details
Comments suppressed due to low confidence (2)
README.md:139
- 当前仓库根目录存在 Apache-2.0 的 LICENSE 文件，但此处写成“本组织下的开源项目默认采用 Apache-2.0 或 MIT”，这会让人误以为本仓库是双许可或许可不确定。README 的 License 段落建议明确本仓库的实际许可证，并链接到仓库内的 LICENSE 文件。
本组织下的开源项目默认采用 [Apache-2.0](https://opensource.org/licenses/Apache-2.0) 或 [MIT](https://opensource.org/licenses/MIT) 开源许可证，具体请参阅各仓库的 `LICENSE` 文件。
README.md:63
- 这里写的是“8 周 / 4 个里程碑”，但下表实际包含 MS0–MS4 共 5 个阶段，表述与内容不一致，容易让读者误解。建议改成与表格一致的阶段数量（例如将 4 改为 5，并说明包含 MS0）。
我们的实战项目采用 **8 周 / 4 个里程碑 (Milestone)** 的敏捷迭代模式，每一轮都交付可演示的闭环产物：
- Files reviewed: 1/1 changed files
- Comments generated: 0 new
- Review effort level: Low
Note
Your feedback helps us improve the quality of this feature.
Please use 👍 or 👎 to tell us whether this assessment is correct.
| | **MS1** | 战略决策与骨架 | 产品 Proposal、**架构主干代码**、首个可串联版本 | | ||
| | **MS2** | MVP 深化落实 | 核心路径跑通、Issue 任务拆解、架构细化 | |
There was a problem hiding this comment.
这里实际内容有调整，
等后续wiki更新了，我同步修改下这里。
Updated the README to reflect the new branding and project focus on XEngineer, including changes to the introduction, project goals, and course details.