Conversation
- add .github/assets/banner.png and drop the floated hero screenshot - follow the gpa-analyzer layout: banner, badges, language switcher - fold the project tree into the tech stack section - note the dev server URL and move the cache warning into an alert block - add a calendar subsection pointing at parse_ics.py as the source of truth - add copyright and disclaimer sections
- npm and github-actions ecosystems only; no Python manifest or Dockerfile here - group minor and patch updates so they land as one PR - target dev, matching the project rule that PRs never go straight to main
- restore .github/assets/hero.png, floated right as before - close the float with <br clear="right"/> ahead of the next section
- reword the intro, feature bullets and project tree comments - trim the content-layer cache explanation down to the command - drop the parse_ics docstring aside and the calendar year range - capitalise Emoji in the pre-submit checklist
xinshoutw
added
documentation
Greptile SummaryUpdates the Chinese and English onboarding documentation, renames the English README, adds a project banner, and configures weekly Dependabot updates targeting the development branch.
Confidence Score: 3/5The PR should not merge until the nonexistent calendar workflow reference and contradictory licensing terms are corrected. The new documentation sends contributors to an unavailable repository path and declares broader licensing terms than the package metadata and license notice support. Files Needing Attention: README.md and README-en.md
|
| Filename | Overview |
|---|---|
| .github/dependabot.yml | Adds valid weekly npm and GitHub Actions update jobs targeting the repository's established dev integration branch. |
| README.md | Reorganizes Chinese documentation but references a nonexistent calendar workflow and conflicts with the package's license declaration. |
| README-en.md | Renames and rewrites the English documentation while duplicating the broken workflow path and conflicting license statement. |
| .github/assets/banner.png | Adds the banner image referenced by both README files. |
Prompt To Fix All With AI
### Issue 1
README.md:69
**Calendar workflow path is missing**
When a contributor follows the calendar conversion instructions, the README directs them to `.claude/skills/calendar-sync`, but `.claude` is empty, so the documented conversion and verification procedure cannot be accessed.
### Issue 2
README.md:137
**License terms contradict metadata**
When contributors or downstream users rely on the new license statement, the README grants AGPL v3.0-or-later while `package.json` declares `AGPL-3.0-only`, leaving the repository with contradictory licensing terms.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Reviews (1): Last reviewed commit: "docs(README): tighten the overview copy ..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| ## 專案架構 | ||
| ### 行事曆 | ||
|
|
||
| 校方 ics 轉 JSON 由 `scripts/parse_ics.py` 完成。轉換流程與驗證步驟見 `.claude/skills/calendar-sync`。 |
There was a problem hiding this comment.
When a contributor follows the calendar conversion instructions, the README directs them to .claude/skills/calendar-sync, but .claude is empty, so the documented conversion and verification procedure cannot be accessed.
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 69
Comment:
**Calendar workflow path is missing**
When a contributor follows the calendar conversion instructions, the README directs them to `.claude/skills/calendar-sync`, but `.claude` is empty, so the documented conversion and verification procedure cannot be accessed.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| 本專案以 [GNU Affero General Public License v3.0](LICENSE) 釋出。第三方素材的授權見 [`NOTICE`](NOTICE)。 | ||
| Copyright (C) 2026 NTUST-OpenSource contributors | ||
|
|
||
| 本專案採用 **GNU Affero General Public License v3.0 或更新版本** 授權，完整條款見 [LICENSE](LICENSE)。第三方素材的授權見 [`NOTICE`](NOTICE) |
There was a problem hiding this comment.
When contributors or downstream users rely on the new license statement, the README grants AGPL v3.0-or-later while package.json declares AGPL-3.0-only, leaving the repository with contradictory licensing terms.
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 137
Comment:
**License terms contradict metadata**
When contributors or downstream users rely on the new license statement, the README grants AGPL v3.0-or-later while `package.json` declares `AGPL-3.0-only`, leaving the repository with contradictory licensing terms.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.1 participant
This pull request updates project documentation for clarity, consistency, and improved onboarding, and adds automated dependency management configuration. The main changes include significant rewrites and reorganization of both the English and Chinese
READMEfiles, the addition of a Dependabot configuration, and various improvements to project structure and contribution guidelines.Documentation and Project Structure Updates:
README.mdandREADME-en.md(renamed fromREADME.en.md) for both Chinese and English, including clearer project introduction, highlights, quick start instructions, updated tech stack, and concise project structure breakdown. Also added a disclaimer and clarified the license section. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]README.mdandREADME-en.md. [1] [2]Contribution and Process Improvements:
Dependency Management:
.github/dependabot.ymlto automate npm and GitHub Actions dependency updates, targeting thedevbranch with weekly schedules and grouped updates.These changes enhance the onboarding experience for new contributors, clarify project maintenance processes, and help keep dependencies up to date automatically.