From d01295c254063b3349a86a4474e04a62b284bd19 Mon Sep 17 00:00:00 2001 From: wanshenmean <cathay_xy@163.com> Date: 星期二, 24 三月 2026 16:26:07 +0800 Subject: [PATCH] 一些配置 --- Code/WCS/AGENTS.md | 62 +++++++++++++++++++++++++++++++ 1 files changed, 62 insertions(+), 0 deletions(-) diff --git a/Code/WCS/AGENTS.md b/Code/WCS/AGENTS.md new file mode 100644 index 0000000..8ecf800 --- /dev/null +++ b/Code/WCS/AGENTS.md @@ -0,0 +1,62 @@ +锘�# Repository Guidelines + +## 椤圭洰缁撴瀯涓庢ā鍧楃粍缁� +鏈粨搴撳寘鍚袱涓牳蹇冨簲鐢細 +- `WIDESEAWCS_Client/`锛歏ue 3 + Vite 鍓嶇锛屼富瑕佺洰褰曞寘鎷� `src/views`銆乣src/components`銆乣src/api`銆乣src/router`銆乣src/store`銆� +- `WIDESEAWCS_Server/`锛欰SP.NET Core 鍚庣瑙ｅ喅鏂规锛坄WIDESEAWCS_Server.sln`锛夛紝鎸夊垎灞傜粍缁囦负 `WIDESEAWCS_*Service`銆乣WIDESEAWCS_*Repository`銆乣WIDESEAWCS_Core`銆乣WIDESEAWCS_Domain`锛岃皟搴︿笌璁惧鐩稿叧浠ｇ爜鍦� `WIDESEAWCS_Tasks` 涓� `WIDESEAWCS_QuartzJob`銆� + +娴嬭瘯涓昏浣嶄簬 `WIDESEAWCS_Server/WIDESEAWCS_Tests`锛坸Unit锛夛紝鍙﹀杩樻湁棰嗗煙涓庨泦鎴愭祴璇曢」鐩�� + +## 鏋勫缓銆佹祴璇曚笌鏈湴寮�鍙戝懡浠� +- 鍓嶇锛堝湪 `WIDESEAWCS_Client/` 鎵ц锛夛細 + - `npm install`锛氬畨瑁呬緷璧栥�� + - `npm run serve`锛氬惎鍔ㄦ湰鍦板紑鍙戞湇鍔★紙Vite锛夈�� + - `npm run build`锛氭瀯寤虹敓浜ц祫婧愩�� + - `npm run lint`锛氭墽琛� ESLint 妫�鏌ャ�� +- 鍚庣锛堝湪 `WIDESEAWCS_Server/` 鎵ц锛夛細 + - `dotnet restore WIDESEAWCS_Server.sln`锛氳繕鍘� NuGet 渚濊禆銆� + - `dotnet build WIDESEAWCS_Server.sln`锛氱紪璇戝叏閮ㄥ悗绔」鐩�� + - `dotnet run --project WIDESEAWCS_Server`锛氭湰鍦板惎鍔� API銆� + - `dotnet test WIDESEAWCS_Tests/WIDESEAWCS_Tests.csproj`锛氳繍琛屽崟鍏冩祴璇曘�� + +## 寮�鍙戞祦绋嬪己鍒惰鑼� +- 鎵�鏈変换鍔″繀椤诲湪 `Code/WCS/.worktrees/<task-name>` 鐙珛 worktree 涓紑鍙戯紝涓嶇洿鎺ュ湪涓诲伐浣滃尯鏀瑰姩銆� +- 鍒嗘敮鍛藉悕缁熶竴锛歚feat/<妯″潡>-<涓婚>`銆乣fix/<妯″潡>-<闂>`銆乣refactor/<妯″潡>-<涓婚>`銆乣docs/<涓婚>`銆� +- 姣忔鎻愪氦鍓嶈嚦灏戞墽琛屼笌鏀瑰姩鐩稿叧鐨勬渶灏忛獙璇侊紙鍓嶇鏀瑰姩璺� `npm run lint`锛涘悗绔敼鍔ㄨ窇 `dotnet test` 鎴栨渶灏忓彲杩愯楠岃瘉锛夈�� +- 绂佹涓�娆℃彁浜ゆ贩鍏ユ棤鍏抽噸鏋勩�佹牸寮忓寲鍣０鎴栧ぇ闈㈢Н鏂囦欢绉诲姩銆� + +## 浠ｇ爜椋庢牸涓庡懡鍚嶈鑼� +- C#锛�4 绌烘牸缂╄繘锛涚被鍨�/鏂规硶/灞炴�т娇鐢� `PascalCase`锛涘眬閮ㄥ彉閲忓拰鍙傛暟浣跨敤 `camelCase`锛涙帴鍙ｄ娇鐢� `I` 鍓嶇紑銆� +- Vue/JS锛氶伒寰幇鏈� ESLint 閰嶇疆涓庨」鐩棦鏈夋ā寮忥紱鏂囦欢鍚嶅簲涓庡姛鑳戒竴鑷达紙濡� `TaskController.cs`銆佸姛鑳界洰褰曚笅 `index.vue`锛夈�� +- 榛樿瑕佹眰锛氬鏂板鎴栦慨鏀圭殑浠ｇ爜娣诲姞璇︾粏涓枃娉ㄩ噴锛岃嚦灏戝寘鍚柟娉曠洰鐨勩�佸弬鏁板惈涔夈�佽繑鍥炲�笺�佸叧閿�昏緫姝ラ鍜屽紓甯稿鐞嗚鏄庛�� +- 娉ㄩ噴瑕佹眰鍙銆佸彲缁存姢锛岀姝⑩�滈噸澶嶄唬鐮佸瓧闈㈡剰鎬濃�濈殑鏃犳晥娉ㄩ噴銆� + +## 鏁版嵁涓�鑷存�т笌浜嬪姟瑙勮寖 +- 鍚屼竴涓氬姟鎿嶄綔娑夊強澶氫釜鏁版嵁瀵硅薄锛堝琛ㄣ�佸浠撳偍銆佽法鏈嶅姟鍐欏叆锛夊悓鏃舵敼鍔ㄦ椂锛屽繀椤讳娇鐢ㄦ暟鎹簱浜嬪姟锛圱ransaction锛変繚璇佸師瀛愭�с�� +- 浜嬪姟鑼冨洿鍙鐩栧繀瑕佸啓鎿嶄綔锛岀姝㈠皢闀胯�楁椂 IO/缃戠粶璋冪敤鏀惧叆浜嬪姟鍐咃紝閬垮厤闀夸簨鍔￠攣琛ㄣ�� +- 鍙戠敓寮傚父鏃跺繀椤诲洖婊氫簨鍔★紝骞惰褰曚簨鍔′笂涓嬫枃锛堜笟鍔″崟鍙枫�佸叧閿富閿�佽皟鐢ㄩ摼鏍囪瘑锛夈�� +- 鑻ユ秹鍙婂垎甯冨紡鎴栬法杈圭晫鍐欏叆锛岄渶鍦� PR 涓槑纭竴鑷存�х瓥鐣ワ紙琛ュ伩銆侀噸璇曘�佸箓绛夐敭锛夈�� + +## 鎺ュ彛銆佹棩蹇椾笌寮傚父瑙勮寖 +- API 杩斿洖缁撴瀯淇濇寔缁熶竴锛屽瓧娈靛懡鍚嶄笌鐜版湁鍚庣搴忓垪鍖栫瓥鐣ヤ竴鑷达紝閬垮厤闅忔剰鍙樻洿鍝嶅簲瀛楁銆� +- Service 灞傛姏鍑虹殑涓氬姟寮傚父闇�鍖呭惈鍙畾浣嶄笂涓嬫枃锛堜换鍔″彿銆佽澶囧彿銆佸叧閿弬鏁帮級銆� +- 鏃ュ織绾у埆瑙勮寖锛氳皟璇曠粏鑺傜敤 `Debug`锛屼笟鍔″叧閿矾寰勭敤 `Information`锛屽彲鎭㈠寮傚父鐢� `Warning`锛屼笉鍙仮澶嶉敊璇敤 `Error`銆� +- 涓ョ鍚炲紓甯革紱鎹曡幏鍚庡繀椤昏褰曚笂涓嬫枃骞跺喅瀹氶噸鎶涙垨杞崲涓轰笟鍔￠敊璇�� +- 娑夊強澶栭儴绯荤粺璋冪敤銆両O銆佺綉缁滈�氫俊銆佽澶囬�氫俊銆佹暟鎹簱璁块棶鐨勫叧閿矾寰勫繀椤讳娇鐢� `try-catch`锛沗catch` 涓嚦灏戣褰曢敊璇俊鎭笌鍏抽敭鍙傛暟锛屽苟淇濈暀鍘熷鍫嗘爤锛坄throw;`锛夛紝绂佹浠� `throw ex;`銆� + +## 娴嬭瘯瑙勮寖 +- 涓昏娴嬭瘯妗嗘灦涓� xUnit锛岄」鐩凡寮曞叆 `Moq`銆乣FluentAssertions`銆乣coverlet.collector`銆� +- 娴嬭瘯鍛藉悕寤鸿锛歚MethodName_ShouldExpectedBehavior`銆� +- 娑夊強琛屼负鍙樺寲鐨勬敼鍔紝蹇呴』鍚屾鏂板鎴栨洿鏂版祴璇曞悗鍐嶅悎骞躲�� + +## 鎻愪氦涓� Pull Request 瑙勮寖 +- 鎻愪氦鍘嗗彶浠ヨ仛鐒﹀瀷鍓嶇紑涓轰富锛歚feat:`銆乣fix:`銆乣refactor:`銆乣docs:`銆乣chore:`锛堜腑鏂囨憳瑕侊級銆� +- 姣忔潯鎻愪氦淇℃伅蹇呴』鍖呭惈璇︾粏鎻愪氦鍐呭锛氳嚦灏戣鏄庢敼浜嗕粈涔堛�佷负浠�涔堟敼銆佸奖鍝嶄簡鍝簺妯″潡/鏂囦欢锛涚姝粎鍐欌�滀慨鏀逛唬鐮佲�濃�滀紭鍖栤�濊繖绫绘ā绯婃弿杩般�� +- PR 蹇呴』璇存槑锛氭敼鍔ㄥ唴瀹广�佹敼鍔ㄥ師鍥犮�佸奖鍝嶈矾寰勩�侀獙璇佹柟寮忎笌缁撴灉銆佹綔鍦ㄩ闄╀笌鍥炴粴鏂规銆� +- 浠呭湪鍓嶇鐣岄潰鍙樻洿鏃堕檮鎴浘锛涙帴鍙ｅ彉鏇撮渶闄勮姹�/鍝嶅簲绀轰緥銆� + +## 瀹夊叏涓庨厤缃鑼� +- 绂佹鎻愪氦瀵嗛挜銆佷护鐗屻�佽繛鎺ヤ覆鏄庢枃锛涙晱鎰熼厤缃繀椤绘斁鍏ョ幆澧冨彉閲忔垨鏈湴鍙楁帶閰嶇疆銆� +- `appsettings*.json` 鐨勭幆澧冨樊寮傞」闇�鏂囨。鍖栵紝閬垮厤鎶婂紑鍙戞満閰嶇疆甯﹀叆娴嬭瘯/鐢熶骇銆� +- 娑夊強鏉冮檺銆侀壌鏉冦�佷腑闂翠欢椤哄簭鐨勬敼鍔紝蹇呴』鍦� PR 涓崟鐙爣娉ㄣ�� + -- Gitblit v1.9.3