feat: 添加项目完整链路说明和开发规范文档
This commit is contained in:
@@ -1,431 +0,0 @@
|
||||
# Hotmail 鍙屾ā寮忛€傞厤寮€鍙戞柟妗?
|
||||
## 1. 鑳屾櫙涓庨棶棰樺垎鏋?
|
||||
褰撳墠浠撳簱鐨?Hotmail 鎺ョ爜璺緞宸茬粡鍥為€€鍒扳€滅涓夋柟閰嶇疆鈥濈増鏈紝鏍稿績鐗圭偣鏄細
|
||||
|
||||
- 璐﹀彿姹犵户缁娇鐢?`閭 / 瀹㈡埛绔?ID / 鍒锋柊浠ょ墝` 浣滀负鎵归噺瀵煎叆鏍煎紡
|
||||
- 鎵╁睍褰撳墠娲昏穬閫昏緫鐩存帴璇锋眰绗笁鏂?HTTP 鎺ュ彛璇诲彇閭欢
|
||||
- 渚ц竟鏍忛澶栨毚闇蹭簡 `API 鍦板潃 / 鍝嶅簲绫诲瀷 / 鏀朵欢绠卞弬鏁?/ 鍨冨溇绠卞弬鏁癭 杩欑粍鍗忚缁嗚妭閰嶇疆
|
||||
|
||||
杩欑増铏界劧鑳藉伐浣滐紝浣嗗凡缁忔毚闇插嚭涓や釜缁撴瀯鎬ч棶棰橈細
|
||||
|
||||
1. **杩滅▼鍗忚鍜屾湰鍦板崗璁苟涓嶄竴鑷?*
|
||||
- `#10` 鏄繙绋嬬涓夋柟鏈嶅姟妯″紡锛屾牳蹇冩槸涓€涓浐瀹氭枃妗f帴鍙?`https://apple.882263.xyz/api.html`
|
||||
- `#42` 鏄湰鍦?helper 妯″紡锛屾牳蹇冩槸鏈湴 Python 鑴氭湰鏆撮湶 `/messages`銆乣/code` 绛夋帴鍙? - 涓よ€呭彧鏄骇鍝佸叆鍙g浉浼硷紝涓嶆槸鍚屼竴鍗忚锛屼笉鑳界‖缁熶竴鎴愪竴濂椻€滈€氱敤 API 鍙傛暟閰嶇疆鍣ㄢ€?
|
||||
2. **褰撳墠 UI 鏆撮湶浜嗚繃澶氬崗璁粏鑺?*
|
||||
- `鍝嶅簲绫诲瀷`
|
||||
- `鏀朵欢绠卞弬鏁癭
|
||||
- `鍨冨溇绠卞弬鏁癭
|
||||
- 杩欎簺瀛楁瀵硅繙绋嬫彁渚涘晢鍗忚鏉ヨ鏄浐瀹氱殑锛屽鏈湴 helper 鍗忚鏉ヨ鍙堟牴鏈笉閫傜敤
|
||||
- 鎶婅繖浜涚粏鑺傛毚闇茬粰鏈€缁堢敤鎴凤紝浼氭妸鐣岄潰鍙樻垚鈥滄帴鍙h皟璇曞櫒鈥濓紝澧炲姞閿欒閰嶇疆椋庨櫓
|
||||
|
||||
3. **鐢ㄦ埛鐪熷疄闇€姹備笉鏄氦浜掓巿鏉冿紝鑰屾槸鎵归噺璐﹀彿姹?*
|
||||
- 闇€瑕佺户缁敮鎸?`璐﹀彿----瀵嗙爜----瀹㈡埛绔疘D----鍒锋柊浠ょ墝`
|
||||
- 闇€瑕佹敮鎸佸嚑鍗佷釜璐﹀彿鐨勬壒閲忓鍏ヤ笌鑷姩杞
|
||||
- 鍥犳褰撳墠闃舵涓嶅簲鍒囧埌鈥滃井杞氦浜掓巿鏉冣€濅富璺嚎
|
||||
|
||||
## 2. 宸查獙璇佸弬鑰冩潵婧?
|
||||
### 2.1 PR #10锛氳繙绋嬬涓夋柟鏈嶅姟妯″紡
|
||||
|
||||
宸茬‘璁ょ壒寰侊細
|
||||
|
||||
- 鎵╁睍鐩存帴璇锋眰杩滅▼鎺ュ彛
|
||||
- 鎺ュ彛鏂囨。宸插叕寮€锛歚https://apple.882263.xyz/api.html`
|
||||
- 鏍稿績鎺ュ彛鏄?`/api/mail-new`
|
||||
- 鎵╁睍浼犲叆锛? - `client_id`
|
||||
- `refresh_token`
|
||||
- `email`
|
||||
- `mailbox`
|
||||
- `response_type`
|
||||
|
||||
璁捐鐗圭偣锛?
|
||||
- 鍗忚鐢辨彁渚涘晢鍥哄畾锛屼笉鍙兘涓哄綋鍓嶉」鐩崟鐙慨鏀?- 鎵╁睍搴旇鍋氣€滃崗璁€傞厤鈥濓紝鑰屼笉鏄鐢ㄦ埛鎵嬪~涓€鍫嗗簳灞傚弬鏁?
|
||||
### 2.2 PR #42锛氭湰鍦?helper 妯″紡
|
||||
|
||||
宸茬‘璁ょ壒寰侊細
|
||||
|
||||
- 鎵╁睍璇锋眰鏈湴 helper锛歚http://127.0.0.1:17373`
|
||||
- helper 鑴氭湰浣嶄簬锛? - `scripts/hotmail_helper.py`
|
||||
- `start-hotmail-helper.bat`
|
||||
- 鎵╁睍浣跨敤鐨勬牳蹇冩帴鍙f槸锛? - `/messages`
|
||||
- `/code`
|
||||
|
||||
璁捐鐗圭偣锛?
|
||||
- 鎵╁睍鍜岄偖绠卞崗璁В鑰?- 鏈湴鑴氭湰鎵挎媴 token 鍒锋柊銆佸彇淇°€侀獙璇佺爜绛涢€?- 鏇撮€傚悎鏈湴鐢ㄦ埛鑷帶鐜
|
||||
|
||||
## 3. 鏈€缁堣璁″彇鑸?
|
||||
### 3.1 鐩爣鏂规
|
||||
|
||||
Hotmail 鍖烘敼鎴?*鍙屾ā寮忛€傞厤**锛?
|
||||
- `杩滅▼鏈嶅姟`
|
||||
- `鏈湴鍔╂墜`
|
||||
|
||||
涓ょ妯″紡缁х画鍏辩敤鍚屼竴濂楄处鍙锋睜涓庢壒閲忓鍏ユ牸寮忥細
|
||||
|
||||
```text
|
||||
璐﹀彿----瀵嗙爜----瀹㈡埛绔疘D----鍒锋柊浠ょ墝
|
||||
```
|
||||
|
||||
### 3.2 涓嶉噰鐢ㄧ殑鏂规
|
||||
|
||||
#### 涓嶉噰鐢ㄢ€滃井杞氦浜掓巿鏉冣€濅富鏂规
|
||||
|
||||
鍘熷洜锛?
|
||||
- 涓嶉€傚悎鍑犲崄涓处鍙风殑鎵归噺浣跨敤鍦烘櫙
|
||||
- 浼氱牬鍧忕幇鏈夋壒閲忓鍏ラ摼璺?- 涓庡綋鍓嶇敤鎴烽渶姹傚啿绐?
|
||||
#### 涓嶉噰鐢ㄢ€滈€氱敤 API 鍙傛暟閰嶇疆鍣ㄢ€?
|
||||
鍘熷洜锛?
|
||||
- 杩滅▼鍗忚鍜屾湰鍦板崗璁湰灏变笉鍚?- 缁х画淇濈暀 `鍝嶅簲绫诲瀷 / 鏀朵欢绠卞弬鏁?/ 鍨冨溇绠卞弬鏁癭 浼氬鍔犻厤缃鏉傚害
|
||||
- 杩欎簺瀛楁涓嶅簲鎴愪负鏈€缁堢敤鎴风殑甯歌閰嶇疆鍏ュ彛
|
||||
|
||||
## 4. 鐩爣浜や簰璁捐
|
||||
|
||||
### 4.1 Hotmail 鍖虹晫闈㈢粨鏋?
|
||||
鍦ㄧ幇鏈?`Hotmail 璐﹀彿姹燻 鍖哄潡涓柊澧烇細
|
||||
|
||||
1. `Hotmail 妯″紡` 鎸夐挳缁? - `杩滅▼鏈嶅姟`
|
||||
- `鏈湴鍔╂墜`
|
||||
|
||||
2. `鏈嶅姟鍦板潃` 杈撳叆妗? - 褰撴ā寮忎负 `杩滅▼鏈嶅姟` 鏃舵樉绀鸿繙绋嬫湇鍔″湴鍧€
|
||||
- 褰撴ā寮忎负 `鏈湴鍔╂墜` 鏃舵樉绀烘湰鍦板姪鎵嬪湴鍧€
|
||||
|
||||
3. 淇濈暀璐﹀彿姹犺〃鍗? - 閭
|
||||
- 瀹㈡埛绔?ID
|
||||
- 閭瀵嗙爜澶囨敞
|
||||
- 鍒锋柊浠ょ墝
|
||||
- 娣诲姞璐﹀彿
|
||||
|
||||
4. 淇濈暀鎵归噺瀵煎叆
|
||||
- 浠嶇劧鏀寔 `璐﹀彿----瀵嗙爜----瀹㈡埛绔疘D----鍒锋柊浠ょ墝`
|
||||
|
||||
5. 淇濈暀璐﹀彿鎿嶄綔
|
||||
- 浣跨敤姝よ处鍙? - 鏍囪宸茬敤 / 鏈敤
|
||||
- 鏍¢獙
|
||||
- 澶嶅埗鏈€鏂伴獙璇佺爜
|
||||
- 鍒犻櫎
|
||||
|
||||
### 4.2 瑕佸垹闄ょ殑鏃?UI
|
||||
|
||||
鍒犻櫎褰撳墠绗笁鏂归厤缃噷杩欏嚑涓粏椤癸細
|
||||
|
||||
- `Hotmail API 鍦板潃`
|
||||
- `鍝嶅簲绫诲瀷`
|
||||
- `鏀朵欢绠卞弬鏁癭
|
||||
- `鍨冨溇绠卞弬鏁癭
|
||||
|
||||
鍘熷洜锛?
|
||||
- 杩欎簺灞炰簬鍗忚缁嗚妭锛屼笉閫傚悎鏅€氫娇鐢ㄨ€?- 鍙屾ā寮忔柟妗堥噷鍙渶瑕侀厤缃€滄湇鍔″湴鍧€鈥?
|
||||
## 5. 鍚庡彴璁捐
|
||||
|
||||
### 5.1 鎸佷箙鍖栭厤缃」
|
||||
|
||||
鏂板骞朵娇鐢ㄤ互涓嬫寔涔呭寲瀛楁锛?
|
||||
- `hotmailServiceMode`
|
||||
- 鍊硷細`remote` / `local`
|
||||
- `hotmailRemoteBaseUrl`
|
||||
- 榛樿锛氳繙绋嬫湇鍔℃枃妗f墍鍦ㄥ煙鍚?- `hotmailLocalBaseUrl`
|
||||
- 榛樿锛歚http://127.0.0.1:17373`
|
||||
|
||||
鍒犻櫎褰撳墠浠呮湇鍔′簬绗笁鏂归€氱敤閰嶇疆鍣ㄧ殑瀛楁锛?
|
||||
- `hotmailApiUrl`
|
||||
- `hotmailApiResponseType`
|
||||
- `hotmailApiInboxMailbox`
|
||||
- `hotmailApiJunkMailbox`
|
||||
|
||||
### 5.2 璇锋眰閫傞厤灞?
|
||||
鏂板缁熶竴鐨勬ā寮忓垎鍙戝眰锛屼絾**涓嶇粺涓€搴曞眰鍗忚**銆?
|
||||
#### 杩滅▼妯″紡
|
||||
|
||||
鐩存帴鍏煎 PR #10 鏂囨。鍗忚锛?
|
||||
- 璋冪敤杩滅▼ `baseUrl + /api/mail-new`
|
||||
- 鎵╁睍绔繚鎸佺幇鏈夆€滄媺娑堟伅鍚庢湰鍦扮瓫楠岃瘉鐮佲€濈殑妯″紡
|
||||
|
||||
#### 鏈湴妯″紡
|
||||
|
||||
鐩存帴鍏煎 PR #42 helper 鍗忚锛?
|
||||
- `/messages`
|
||||
- `/code`
|
||||
|
||||
鎵╁睍绔€昏緫锛?
|
||||
- `鏍¢獙` / `娴嬭瘯鏀朵俊` 璧?`/messages`
|
||||
- 楠岃瘉鐮佽疆璇紭鍏堣蛋 `/code`
|
||||
|
||||
### 5.3 闇€瑕佹柊澧炴垨璋冩暣鐨勫悗鍙板嚱鏁?
|
||||
1. 閰嶇疆褰掍竴鍖? - `normalizeHotmailServiceMode`
|
||||
- `normalizeHotmailRemoteBaseUrl`
|
||||
- `normalizeHotmailLocalBaseUrl`
|
||||
- `getHotmailServiceSettings`
|
||||
|
||||
2. 杩滅▼妯″紡閫傞厤
|
||||
- `requestHotmailRemoteMailbox`
|
||||
- `fetchHotmailRemoteMessages`
|
||||
|
||||
3. 鏈湴妯″紡閫傞厤
|
||||
- `requestHotmailLocalMessages`
|
||||
- `requestHotmailLocalCode`
|
||||
- `fetchHotmailLocalMessages`
|
||||
|
||||
4. 缁熶竴鍒嗗彂鍏ュ彛
|
||||
- `fetchHotmailMailboxMessages`
|
||||
- `pollHotmailVerificationCode`
|
||||
- 鏍规嵁妯″紡鍒嗘祦
|
||||
|
||||
## 6. 鏈湴 helper 鏂囦欢绛栫暐
|
||||
|
||||
鐩存帴寮曞叆骞堕€傞厤 PR #42 宸查獙璇佺殑鏈湴鑴氭湰鏂规锛?
|
||||
- `scripts/hotmail_helper.py`
|
||||
- `start-hotmail-helper.bat`
|
||||
|
||||
寮曞叆鍘熷垯锛?
|
||||
- 浼樺厛淇濇寔鍗忚鍏煎锛屼笉鍋氭棤蹇呰閲嶆瀯
|
||||
- 鍙帴鍏ュ綋鍓嶆墿灞曢渶瑕佺敤鍒扮殑鎺ュ彛涓庡惎鍔ㄦ柟寮?- 涓嶅湪鏈疆鎵╁睍寮€鍙戜腑缁х画寮曞叆涓?Hotmail 妯″紡鍒囨崲鏃犲叧鐨勫ぇ瑙勬ā鐘舵€侀€昏緫
|
||||
|
||||
## 7. 涓庣幇鏈夐€昏緫鐨勫吋瀹硅姹?
|
||||
### 7.1 蹇呴』淇濇寔涓嶅彉鐨勮涓?
|
||||
- `Mail = Hotmail` 鏃朵粛鐒剁敱璐﹀彿姹犲垎閰嶉偖绠?- `璐﹀彿----瀵嗙爜----瀹㈡埛绔疘D----鍒锋柊浠ょ墝` 鎵归噺瀵煎叆鏍煎紡蹇呴』缁х画鍙敤
|
||||
- `鏍¢獙` / `澶嶅埗鏈€鏂伴獙璇佺爜` / `Auto` 鐨勭敤鎴峰叆鍙d笉鍙?- Hotmail 璐﹀彿鐨?`used / status / lastError / lastAuthAt / lastUsedAt` 閫昏緫淇濇寔鐜版湁璇箟
|
||||
|
||||
### 7.2 蹇呴』閬垮厤鐨勯棶棰?
|
||||
- 涓嶈兘鎶婅繙绋嬪拰鏈湴寮鸿鎶芥垚涓€濂楀亣缁熶竴鍗忚
|
||||
- 涓嶈兘鎶婄涓夋柟鏈嶅姟瑕佹眰鏀规垚 `/messages` `/code`
|
||||
- 涓嶈兘鍒犻櫎鎵归噺瀵煎叆 refresh token 鐨勮兘鍔?- 涓嶈兘鍙敼 UI锛屼笉鎺ュ悗鍙板垎鍙?- 涓嶈兘鍙帴鍚庡彴锛屼笉鍚屾 README 涓庤鏄?
|
||||
## 8. 鏂规鑷涓庡畬鏁存€у垎鏋?
|
||||
### 8.1 鏂规鏄惁绗﹀悎闇€姹?
|
||||
绗﹀悎銆?
|
||||
鍘熷洜锛?
|
||||
- 淇濈暀鎵归噺瀵煎叆
|
||||
- 涓嶅己杩敤鎴疯蛋寰蒋浜や簰鎺堟潈
|
||||
- 鍚屾椂鏀寔宸查獙璇佺殑杩滅▼涓庢湰鍦颁袱绉嶈矾寰?
|
||||
### 8.2 鏂规鏄惁瀹屾暣
|
||||
|
||||
瀹屾暣銆?
|
||||
宸茬粡瑕嗙洊锛?
|
||||
- 閰嶇疆妯″瀷
|
||||
- 鐣岄潰鍙樻洿
|
||||
- 鍚庡彴鍒嗗彂
|
||||
- helper 寮曞叆
|
||||
- 鏂囨。鏇存柊
|
||||
- 鑷椤?
|
||||
### 8.3 鏂规鏄惁瀛樺湪鍐呴儴鍐茬獊
|
||||
|
||||
褰撳墠鏃犳槑鏄惧啿绐併€?
|
||||
鍞竴闇€瑕佷弗鏍兼帶鍒剁殑鏄細
|
||||
|
||||
- 杩滅▼妯″紡涓庢湰鍦版ā寮忚櫧鐒跺叆鍙g粺涓€锛屼絾鍗忚涓嶈兘娣风敤
|
||||
- 瀹炵幇鏃跺繀椤绘槑纭垎灞傦紝涓嶈鍋氭垚鈥滄牴鎹厤缃嫾涓嶅悓 query 鍙傛暟鈥濈殑鏉傜硡閫昏緫
|
||||
|
||||
### 8.4 鏂规娼滃湪缂洪櫡
|
||||
|
||||
1. 鏈湴 helper 鍙兘渚濊禆 Python 鐜
|
||||
- 闇€瑕佸湪 README 涓槑纭鏄庡浣曞惎鍔?
|
||||
2. 杩滅▼鏈嶅姟鏂囨。鑻ユ湭鏉ュ彉鏇? - 褰撳墠浠嶄緷璧栨湇鍔″晢鎺ュ彛绋冲畾鎬?
|
||||
3. 褰撳墠浠撳簱鏄棫椤圭洰
|
||||
- Hotmail 閫昏緫鍛ㄨ竟宸叉湁杈冨鐘舵€佸瓧娈? - 瀹炵幇鏃跺繀椤昏皑鎱庢鏌?`verify/test/poll/auto-run` 鍥涙潯閾炬槸鍚︾粺涓€鎸夋ā寮忓垎鍙?
|
||||
## 9. 寮€鍙戞竻鍗?
|
||||
### 闃舵 1锛氶厤缃ā鍨嬩笌鏂规钀界洏
|
||||
|
||||
- 鏂板缓鏈柟妗堟枃妗?- 鏂板 Hotmail 鍙屾ā寮忔寔涔呭寲瀛楁
|
||||
- 鍒犻櫎鏃х殑绗笁鏂瑰崗璁粏椤瑰瓧娈?
|
||||
鑷锛?
|
||||
- 閰嶇疆椤瑰懡鍚嶆槸鍚︾粺涓€
|
||||
- 榛樿鍊兼槸鍚﹀畬鏁?- import/export 鏄惁浠嶅彲宸ヤ綔
|
||||
|
||||
### 闃舵 2锛欻otmail UI 鏀归€?
|
||||
- 鏂板 `杩滅▼鏈嶅姟 / 鏈湴鍔╂墜` 妯″紡鎸夐挳
|
||||
- 鏂板 `鏈嶅姟鍦板潃` 杈撳叆妗?- 鍒犻櫎鏃х殑 `鍝嶅簲绫诲瀷 / 鏀朵欢绠卞弬鏁?/ 鍨冨溇绠卞弬鏁癭 杈撳叆妗?- 淇濈暀璐﹀彿姹犺〃鍗曚笌鎵归噺瀵煎叆
|
||||
|
||||
鑷锛?
|
||||
- 鍒囨崲妯″紡鍚庢樉绀烘槸鍚︽纭?- 鑷姩淇濆瓨鏄惁浠嶆甯?- 涓嶅悓妯″紡鐨勫湴鍧€鏄惁涓嶄細浜掔浉瑕嗙洊
|
||||
|
||||
### 闃舵 3锛氬悗鍙板弻妯″紡閫傞厤
|
||||
|
||||
- 瀹炵幇杩滅▼妯″紡璇锋眰閫傞厤
|
||||
- 瀹炵幇鏈湴妯″紡 helper 璇锋眰閫傞厤
|
||||
- 淇敼 `fetchHotmailMailboxMessages`
|
||||
- 淇敼 `pollHotmailVerificationCode`
|
||||
- 鏍¢獙 `verify / test / auto-run` 涓夋潯閾?
|
||||
鑷锛?
|
||||
- 杩滅▼妯″紡鏄惁浠嶅吋瀹?`#10`
|
||||
- 鏈湴妯″紡鏄惁鍏煎 `#42`
|
||||
- 閿欒淇℃伅鏄惁浠嶄細鍐欏洖 `lastError`
|
||||
|
||||
### 闃舵 4锛氬紩鍏ユ湰鍦?helper
|
||||
|
||||
- 寮曞叆 `scripts/hotmail_helper.py`
|
||||
- 寮曞叆 `start-hotmail-helper.bat`
|
||||
- 妫€鏌ユ湰鍦板崗璁笌鎵╁睍璋冪敤涓€鑷?
|
||||
鑷锛?
|
||||
- helper 璺緞鏄惁姝g‘
|
||||
- 绔彛涓庢枃妗f槸鍚︿竴鑷?- 鎵╁睍璇锋眰璺緞鏄惁鍖归厤 helper
|
||||
|
||||
### 闃舵 5锛氭枃妗f敹灏?
|
||||
- 鏇存柊 README 涓?Hotmail 浣跨敤璇存槑
|
||||
- 鏄庣‘杩滅▼妯″紡涓庢湰鍦版ā寮忕殑鍖哄埆
|
||||
- 鏄庣‘鏈湴 helper 鍚姩鏂瑰紡
|
||||
|
||||
鑷锛?
|
||||
- README 鏄惁鍜岀湡瀹?UI 涓€鑷?- 鐢ㄦ埛鏄惁鑳界湅鏂囨。瀹屾垚閰嶇疆
|
||||
|
||||
## 10. 瀹炴柦椤哄簭
|
||||
|
||||
鏈疆寮€鍙戜弗鏍兼寜浠ヤ笅椤哄簭鎵ц锛?
|
||||
1. 鍏堝啓鏈柟妗堟枃妗?2. 鍐嶆敼閰嶇疆妯″瀷
|
||||
3. 鍐嶆敼 UI
|
||||
4. 鍐嶆敼鍚庡彴鍙屾ā寮忓垎鍙?5. 鍐嶅紩鍏ユ湰鍦?helper
|
||||
6. 鏈€鍚庣粺涓€鍋氶潤鎬佽嚜妫€骞舵彁閱掔敤鎴锋墜娴?
|
||||
## 11. 瀹為檯寮€鍙戣褰?
|
||||
### 11.1 宸插畬鎴愭敼鍔?
|
||||
鏈疆宸插疄闄呭畬鎴愪互涓嬪紑鍙戝唴瀹癸細
|
||||
|
||||
1. Hotmail 閰嶇疆妯″瀷浠庘€滅涓夋柟閫氱敤缁嗛」閰嶇疆鈥濆垏鎹负鈥滃弻妯″紡 + 鍦板潃閰嶇疆鈥? - 鍒犻櫎鍘熸湰闈㈠悜绗笁鏂圭粏椤圭殑鎬濊矾锛? - `hotmailApiUrl`
|
||||
- `hotmailApiResponseType`
|
||||
- `hotmailApiInboxMailbox`
|
||||
- `hotmailApiJunkMailbox`
|
||||
- 鏀逛负锛? - `hotmailServiceMode`
|
||||
- `hotmailRemoteBaseUrl`
|
||||
- `hotmailLocalBaseUrl`
|
||||
|
||||
2. Sidepanel Hotmail 鍖哄凡鏀归€犳垚鍙屾ā寮?UI
|
||||
- 鏂板 `杩滅▼鏈嶅姟 / 鏈湴鍔╂墜` 鎸夐挳缁? - 鏂板杩滅▼鏈嶅姟鍦板潃杈撳叆妗? - 鏂板鏈湴鍔╂墜鍦板潃杈撳叆妗? - 淇濈暀鍘熸湁璐﹀彿姹犺〃鍗曞拰鎵归噺瀵煎叆鏍煎紡
|
||||
|
||||
3. 鍚庡彴 Hotmail 璇锋眰閾惧凡鎸夋ā寮忓垎娴? - 杩滅▼妯″紡锛? - 鐩存帴鍏煎 `#10`
|
||||
- 浣跨敤 `baseUrl + /api/mail-new`
|
||||
- 鏈湴妯″紡锛? - 鐩存帴鍏煎 `#42`
|
||||
- 浣跨敤 `/messages`
|
||||
- 浣跨敤 `/code`
|
||||
|
||||
4. 鏈湴 helper 鏂囦欢宸茶惤鍦? - `scripts/hotmail_helper.py`
|
||||
- `start-hotmail-helper.bat`
|
||||
|
||||
5. README 宸插悓姝ユ洿鏂颁负鍙屾ā寮忚鏄?
|
||||
### 11.2 瀹為檯淇敼鏂囦欢
|
||||
|
||||
鏈疆瀹為檯鏀瑰姩鏂囦欢濡備笅锛?
|
||||
- `background.js`
|
||||
- `sidepanel/sidepanel.html`
|
||||
- `sidepanel/sidepanel.js`
|
||||
- `README.md`
|
||||
- `scripts/hotmail_helper.py`
|
||||
- `start-hotmail-helper.bat`
|
||||
|
||||
鏈疆鏂板浣嗕笉涓€瀹氳繘鍏?Git 鐨勬枃妗o細
|
||||
|
||||
- `docs/md/Hotmail鍙屾ā寮忛€傞厤寮€鍙戞柟妗?md`
|
||||
|
||||
### 11.3 瀹為檯瀹炵幇涓庡師鏂规鐨勫樊寮?
|
||||
褰撳墠瀹炵幇涓庡師鏂规鐩告瘮锛屽瓨鍦ㄨ繖浜涘疄闄呭樊寮傦細
|
||||
|
||||
1. 鏈湴 helper 娌℃湁鏁翠唤鐓ф惉 `#42`
|
||||
- 褰撳墠鏄寜 `#42` 鐨勫崗璁€濊矾钀戒簡涓€涓畝鍖栫増
|
||||
- 鐩爣鏄厛婊¤冻鎵╁睍鐜伴樁娈电殑 `/messages` 涓?`/code`
|
||||
- 娌℃湁缁х画寮曞叆 `#42` 閲屾洿閲嶇殑澶辫触鐘舵€併€佹寔涔呭凡鐢ㄩ偖绠便€佸苟鍙戜繚鎶ょ瓑鏁村鎵╁睍閫昏緫
|
||||
|
||||
2. 杩滅▼妯″紡鐩墠浠嶆部鐢ㄦ墿灞曠鏈湴绛涢獙璇佺爜
|
||||
- 鍏煎 `#10` 鐨勫崟鎺ュ彛 `/api/mail-new`
|
||||
- 鏈澶栧鎺?`mail-all`銆乣process-inbox`銆乣process-junk`
|
||||
|
||||
3. 娴嬭瘯鏂囦欢鏈疆娌℃湁缁х画琛ラ綈
|
||||
- 褰撳墠涓昏瀹屾垚鐨勬槸鏂规钀藉湴鍜屼富閾炬敼閫? - 灏氭湭琛ラ拡瀵瑰弻妯″紡鐨勬渶灏忓洖褰掓祴璇曟々
|
||||
|
||||
### 11.4 褰撳墠宸茬煡鏈畬鎴愰」
|
||||
|
||||
浠ヤ笅鍐呭褰撳墠浠嶆湭瀹屾垚鎴栨湭楠岃瘉锛?
|
||||
1. 鏈ˉ Hotmail 鍙屾ā寮忓搴旂殑娴嬭瘯妗? - 杩滅▼妯″紡楠岃瘉閫昏緫
|
||||
- 鏈湴妯″紡 `/messages` 涓?`/code` 鍒嗗彂閫昏緫
|
||||
- 妯″紡鍒囨崲鍚庣殑 UI 鐘舵€佸洖濉?
|
||||
2. 鏈 helper 鍋氳繍琛岀骇瀹炴祴
|
||||
- 褰撳墠鍙畬鎴愪唬鐮佹帴鍏? - 灏氭湭纭鏈満 Python 鐜涓?`imaplib + XOAUTH2 + login.live.com/oauth20_token.srf` 鏄惁鑳界ǔ瀹氬伐浣?
|
||||
3. 鏈獙璇佽繙绋嬫湇鍔″湴鍧€鐨勪笉鍚岃緭鍏ュ舰寮? - 渚嬪鐢ㄦ埛濉細
|
||||
- 鏍瑰煙鍚? - `/api.html`
|
||||
- `/api/mail-new`
|
||||
- 鐩墠浠g爜鍋氫簡璺緞褰掍竴鍖栵紝浣嗛渶瑕佷汉宸ユ墜娴嬬‘璁?
|
||||
4. 鏈ˉ README 涓洿缁嗙殑鏈湴 helper 鍚姩鎺掗敊璇存槑
|
||||
- 褰撳墠鍙啓浜嗗叆鍙h鏄? - 杩樻病鍐欌€滃惎鍔ㄥけ璐ユ€庝箞鐪嬨€佺鍙e崰鐢ㄦ€庝箞鍔炪€丳ython 涓嶅瓨鍦ㄦ€庝箞鍔炩€?
|
||||
### 11.5 褰撳墠鎵嬫祴閲嶇偣
|
||||
|
||||
鍚庣画浼樺厛鎵嬫祴浠ヤ笅鍐呭锛?
|
||||
1. 杩滅▼妯″紡
|
||||
- `Mail = Hotmail`
|
||||
- 妯″紡鍒囧埌 `杩滅▼鏈嶅姟`
|
||||
- 鍦板潃濉?`https://apple.882263.xyz`
|
||||
- 娴嬶細
|
||||
- `鏍¢獙`
|
||||
- `澶嶅埗鏈€鏂伴獙璇佺爜`
|
||||
- `Auto`
|
||||
|
||||
2. 鏈湴妯″紡
|
||||
- 鍏堣繍琛?`start-hotmail-helper.bat`
|
||||
- 妯″紡鍒囧埌 `鏈湴鍔╂墜`
|
||||
- 鍦板潃淇濇寔 `http://127.0.0.1:17373`
|
||||
- 娴嬶細
|
||||
- `鏍¢獙`
|
||||
- `澶嶅埗鏈€鏂伴獙璇佺爜`
|
||||
- `Auto`
|
||||
|
||||
3. 妯″紡鍒囨崲
|
||||
- 浠?`杩滅▼鏈嶅姟` 鍒囧埌 `鏈湴鍔╂墜`
|
||||
- 浠?`鏈湴鍔╂墜` 鍒囧埌 `杩滅▼鏈嶅姟`
|
||||
- 鐪嬪湴鍧€鏄惁鍒嗗埆淇濈暀
|
||||
- 鐪?Hotmail 璐﹀彿姹犳槸鍚︿笉鍙楀奖鍝?
|
||||
4. 鎵归噺瀵煎叆
|
||||
- 瀵煎叆鏍煎紡锛? - `璐﹀彿----瀵嗙爜----瀹㈡埛绔疘D----鍒锋柊浠ょ墝`
|
||||
- 妫€鏌ユā寮忓垏鎹㈠悗瀵煎叆鑳藉姏鏄惁浠嶆甯?
|
||||
### 11.6 褰撳墠椋庨櫓缁撹
|
||||
|
||||
褰撳墠鏈€澶ч闄╀笉鍦?UI锛岃€屽湪杩欎袱涓偣锛?
|
||||
1. 鏈湴 helper 鐨勭湡瀹炲彲杩愯鎬? - 浠g爜宸茬粡鎺ヤ笂
|
||||
- 浣嗘湭缁忓疄闄呰繍琛岄獙璇?
|
||||
2. 杩滅▼涓庢湰鍦扮殑杩斿洖缁撴瀯鍏煎鎬? - 杩滅▼妯″紡璧?`#10` 椋庢牸
|
||||
- 鏈湴妯″紡璧?`#42` 椋庢牸
|
||||
- 铏界劧鍚庡彴宸茬粡鍋氫簡閫傞厤锛屼絾浠嶉渶瑕佸疄闄呰繑鍥炴牱鏈獙璇?
|
||||
### 11.7 褰撳墠闃舵缁撹
|
||||
|
||||
褰撳墠鐘舵€佸彲浠ョ悊瑙d负锛?
|
||||
- 鏂规宸茶惤鐩?- 鍙屾ā寮忎富缁撴瀯宸插紑鍙戝畬鎴?- 杩滅▼ / 鏈湴涓ゆ潯鍗忚宸叉帴鍏?- 璐﹀彿姹犱笌鎵归噺瀵煎叆浠嶄繚鐣?- 浣嗗皻鏈粡杩囩湡瀹炶繍琛岄獙璇?
|
||||
鍥犳鏈疆寮€鍙戠粨鏋滃睘浜庯細
|
||||
|
||||
- **浠g爜缁撴瀯宸插埌浣?*
|
||||
- **杩愯绋冲畾鎬у緟浜哄伐楠岃瘉**
|
||||
|
||||
## 12. 本地 helper 运行说明补充
|
||||
|
||||
### 12.1 启动命令
|
||||
|
||||
Windows:
|
||||
|
||||
```powershell
|
||||
.\start-hotmail-helper.bat
|
||||
```
|
||||
|
||||
macOS:
|
||||
|
||||
```bash
|
||||
chmod +x ./start-hotmail-helper.command
|
||||
./start-hotmail-helper.command
|
||||
```
|
||||
|
||||
如果不使用启动脚本,也可以直接运行:
|
||||
|
||||
```bash
|
||||
python scripts/hotmail_helper.py
|
||||
```
|
||||
|
||||
或:
|
||||
|
||||
```bash
|
||||
python3 scripts/hotmail_helper.py
|
||||
```
|
||||
|
||||
### 12.2 启动成功标志
|
||||
|
||||
启动成功后,终端应输出:
|
||||
|
||||
```text
|
||||
Hotmail helper listening on http://127.0.0.1:17373
|
||||
```
|
||||
|
||||
### 12.3 最小排错说明
|
||||
|
||||
- 若提示 `Python 3 not found`,说明当前机器没有可用的 Python 3.10+。
|
||||
- 若 helper 已启动但扩展仍连不上,先确认 Hotmail 模式切到了 `本地助手`。
|
||||
- 再确认侧边栏中的本地助手地址与终端输出一致,默认应为 `http://127.0.0.1:17373`。
|
||||
- 若地址一致仍失败,再检查终端中是否已经打印异常,或是否有端口占用。
|
||||
@@ -4,6 +4,12 @@
|
||||
|
||||
本文件用于给仓库协作者自己电脑上的 AI 一个固定、完整、可重复执行的 PR 处理流程。
|
||||
|
||||
执行本流程时,AI 必须同时把下面三份根目录文档作为审查依据一起阅读:
|
||||
|
||||
- [项目文件结构说明.md](c:/Users/projectf/Downloads/codex注册扩展/项目文件结构说明.md)
|
||||
- [项目完整链路说明.md](c:/Users/projectf/Downloads/codex注册扩展/项目完整链路说明.md)
|
||||
- [项目开发规范(AI协作).md](c:/Users/projectf/Downloads/codex注册扩展/项目开发规范(AI协作).md)
|
||||
|
||||
下次只要告诉 AI:
|
||||
|
||||
- 本仓库根目录
|
||||
@@ -28,6 +34,14 @@
|
||||
12. 如果流程执行过程中,PR 的实时目标分支被别人改掉,或者不再是 `dev`,AI 必须停止当前合并流程,重新拉取信息后再决定下一步。
|
||||
13. 进入“阶段 2:分析与审查”时,AI 必须先给当前 PR 添加 `审查中` 标签,并在开始正式审查前确认该标签已经在线上生效。
|
||||
14. 审查结束后,AI 必须根据实际结论把 PR 标签从 `审查中` 切换为 `完成` 或 `等待修改`,并同时把受理人设置为自己;在确认线上状态已更新前,不允许声称审查已完成。
|
||||
15. 审查时必须检查该 PR 是否遵守 [项目开发规范(AI协作).md](c:/Users/projectf/Downloads/codex注册扩展/项目开发规范(AI协作).md),不能只检查功能是否可用。
|
||||
16. 如果 PR 功能本身没问题,但明显违反开发规范,例如:
|
||||
- 把大段逻辑重新堆回主文件
|
||||
- 没补测试或破坏测试边界
|
||||
- 没同步文档
|
||||
- 破坏共享步骤定义/注册表
|
||||
- 引入可见乱码
|
||||
则也必须判定为“需要修改后再继续”,不能直接给出可合并结论。
|
||||
|
||||
## 输入要求
|
||||
|
||||
@@ -127,6 +141,7 @@ gh pr edit <PR_NUMBER> --add-label "审查中" --repo <OWNER/REPO>
|
||||
- 这些改动是否合理
|
||||
- 是否存在 bug / 风险 / 逻辑冲突
|
||||
- PR 当前是否可直接合并,例如 `mergeable`、`mergeStateStatus`
|
||||
- 是否遵守项目开发规范
|
||||
6. 如果发现问题,结论必须按严重级别排序,优先写真正会影响功能、合并或后续维护的问题。
|
||||
7. 如果没有发现明确问题,也要说明剩余风险,例如:
|
||||
- 未运行测试
|
||||
@@ -136,6 +151,12 @@ gh pr edit <PR_NUMBER> --add-label "审查中" --repo <OWNER/REPO>
|
||||
- PR 仍然是打开状态
|
||||
- PR 不是 draft
|
||||
- `baseRefName` 仍然是 `dev`
|
||||
9. 审查输出中必须单独包含一节“开发规范符合性检查”,至少明确说明:
|
||||
- 是否违反 [项目开发规范(AI协作).md](c:/Users/projectf/Downloads/codex注册扩展/项目开发规范(AI协作).md)
|
||||
- 是否需要补测试
|
||||
- 是否需要补文档
|
||||
- 是否发现可见乱码或编码异常
|
||||
- 是否存在把逻辑重新堆回主文件的情况
|
||||
|
||||
## 分析后评论规则
|
||||
|
||||
@@ -144,7 +165,7 @@ gh pr edit <PR_NUMBER> --add-label "审查中" --repo <OWNER/REPO>
|
||||
如果发现需要作者或维护者注意的问题,AI 必须自动发 PR 评论,并且评论格式必须固定如下:
|
||||
|
||||
```text
|
||||
(自动回复)AI分析结果(不一定完全正确,请仓库协作者确认无问题后再继续):
|
||||
(自动回复)AI分析结果(不一定完全正确,请进行确认,若无问题后请评论回复):
|
||||
|
||||
<这里写正式评论内容>
|
||||
```
|
||||
@@ -160,6 +181,12 @@ gh pr edit <PR_NUMBER> --add-label "审查中" --repo <OWNER/REPO>
|
||||
7. 如果结论是“当前不能通过审查”,AI 必须明确写出“需要修改后再继续”,不能只写模糊提醒。
|
||||
8. 如果当前环境支持正式 PR review,且问题足以阻止合并,优先使用带“要求更改(Request changes)”语义的审查,而不是只留普通闲聊式评论。
|
||||
9. 行级评论是对总评论的补充,不得用零散行级评论替代总评论结论。
|
||||
10. 如果问题属于“开发规范不符合”,总评论中必须明确写出违反的是哪类规范,例如:
|
||||
- 模块边界不符合
|
||||
- 测试缺失
|
||||
- 文档未同步
|
||||
- 出现乱码
|
||||
- 共享步骤定义未同步
|
||||
|
||||
### 没问题时
|
||||
|
||||
@@ -252,6 +279,10 @@ git merge --no-ff --no-commit origin/dev
|
||||
6. 要重新拉取一次实时 PR 元数据,确认该 PR 的 `baseRefName` 仍然是 `dev`;如果不是,停止后续合并并先反馈用户。
|
||||
7. 要确认 PR 当前已经回到可继续处理的状态,例如不再是 `draft`,且 `mergeable` / `mergeStateStatus` 没有出现新的阻塞。
|
||||
8. 默认不编译测试,最后提醒用户自行测试。
|
||||
9. 如果本地代修过程中涉及结构调整、功能链路变化或开发边界变化,必须同时检查并在必要时更新:
|
||||
- [项目文件结构说明.md](c:/Users/projectf/Downloads/codex注册扩展/项目文件结构说明.md)
|
||||
- [项目完整链路说明.md](c:/Users/projectf/Downloads/codex注册扩展/项目完整链路说明.md)
|
||||
- [项目开发规范(AI协作).md](c:/Users/projectf/Downloads/codex注册扩展/项目开发规范(AI协作).md)
|
||||
|
||||
## 合并提交信息规则
|
||||
|
||||
|
||||
Reference in New Issue
Block a user