编辑 | blame | 历史 | 原始文档

Repository Guidelines

ÏîÄ¿½á¹¹ÓëÄ£¿é×éÖ¯

±¾²Ö¿âÊÇÒ»¸ö°´·Ö²ãÖ°Ôð×éÖ¯µÄ¶àÏîÄ¿ .NET ½â¾ö·½°¸£¨WIDESEAWCS_Server.sln£©¡£
- WIDESEAWCS_Server/£ºASP.NET Core Ö÷»ú¡¢¿ØÖÆÆ÷¡¢Æô¶¯¹ÜÏߣ¬¾²Ì¬×ÊԴλÓÚ wwwroot/¡£
- WIDESEAWCS_Core/£ºÍ¨Óûù´¡ÉèÊ©£¨DI¡¢Öмä¼þ¡¢¼øÈ¨¡¢Êý¾Ý¿âÅäÖᢻù´¡³éÏ󣩡£
- WIDESEAWCS_Model/ Óë WIDESEAWCS_DTO/£ºÊµÌåÄ£ÐÍÓë´«Êä¶ÔÏó¡£
- WIDESEAWCS_*Repository + WIDESEAWCS_*Service£ºSystem¡¢TaskInfo¡¢BasicInfo ÁìÓòµÄ½Ó¿Ú/ʵÏֲַ㡣
- WIDESEAWCS_Tasks/ Óë WIDESEAWCS_QuartzJob/£ºÉ豸ÈÎÎñ±àÅÅÓëµ÷¶È¡£
- WIDESEAWCS_Tests/£º×Ô¶¯»¯µ¥Ôª²âÊÔ£¨xUnit£©¡£
- docs/superpowers/£ºÉè¼ÆÎĵµÓëʵʩ¼Æ»®¡£

¹¹½¨¡¢²âÊÔÓë±¾µØ¿ª·¢ÃüÁî

  • dotnet restore WIDESEAWCS_Server.sln£º»¹Ô­ËùÓÐ NuGet ÒÀÀµ¡£
  • dotnet build WIDESEAWCS_Server.sln -c Debug£º±àÒëÈ«²¿ÏîÄ¿¡£
  • dotnet test WIDESEAWCS_Tests/WIDESEAWCS_Tests.csproj£ºÔËÐе¥Ôª²âÊÔ¡£
  • dotnet run --project WIDESEAWCS_Server/WIDESEAWCS_Server.csproj£º±¾µØÆô¶¯ API ·þÎñ¡£

ÓÅÏÈʹÓýâ¾ö·½°¸¼¶ÃüÁÐèÒª¿ìËÙµü´úʱÔÙÇл»µ½ÏîÄ¿¼¶ÃüÁî¡£

´úÂë·ç¸ñÓëÃüÃû¹æ·¶

  • ÓïÑÔ£ºC#£¬¸÷ÏîÄ¿ÒÑÆôÓÿɿÕÒýÓã¨nullable£©¡£
  • Ëõ½ø£º4 ¸ö¿Õ¸ñ£»´óÀ¨ºÅ»»ÐУ¨ÓëÏÖÓдúÂë±£³ÖÒ»Ö£©¡£
  • ÃüÃû£ºÀàÐÍ/·½·¨/ÊôÐÔʹÓà PascalCase£¬¾Ö²¿±äÁ¿/²ÎÊýʹÓà camelCase£¬½Ó¿ÚÒÔ I ǰ׺ÃüÃû¡£
  • ÎļþÃüÃûÓëÀàÐÍÃû±£³ÖÒ»Ö£¨ÀýÈç Sys_UserService.cs¡¢TaskController.cs£©¡£
  • .editorconfig µ±Ç°¶Ô *.cs ÒÖÖÆ CS8618£»Î´¾­ÍŶÓÈ·Èϲ»ÒªÐÂÔö´ó·¶Î§¾¯¸æÒÖÖÆ¡£
  • ΪÐÂÉú³É»òÕßÐ޸ĵĴúÂëµÄÿһÐÐÌí¼ÓÏêϸעÊÍ£¬°üÀ¨£º
  • ·½·¨µÄÄ¿µÄ˵Ã÷
  • ²ÎÊý˵Ã÷
  • ·µ»ØÖµËµÃ÷
  • ÿһÐдúÂëµÄ×÷ÓÃ
  • Òì³£Çé¿öµÄ˵Ã÷

²âÊԹ淶

  • ²âÊÔÕ»£ºxUnit + Microsoft.NET.Test.Sdk£¬²¢ÒÑÒýÈë Moq¡¢FluentAssertions¡¢coverlet.collector¡£
  • ²âÊÔÃüÃû½¨Ò飺MethodName_ShouldExpectedBehavior£¨ÀýÈç WaitIntervalMs_ShouldBe500£©¡£
  • ÐÞ¸ÄÒµÎñÂß¼­¡¢³£Á¿»ò·þÎñÐÐΪʱ£¬Ðèͬ²½ÐÂÔö/¸üвâÊÔ¡£
  • ÍÆËÍǰÇë±¾µØÖ´ÐÐ dotnet test¡£

Ìá½»Óë Pull Request ¹æ·¶

  • ×î½üÌá½»ÀúÊ·ÇãÏòʹÓüò¶Ì¡¢¾Û½¹µÄǰ׺·ç¸ñ£ºfeat:¡¢fix:¡¢docs:¡¢chore:¡¢config:¡£
  • Ìá½»±êÌâʹÓÃÆíʹ¾ä£¬µ¥´ÎÌá½»¾Û½¹µ¥Ò»±ä¸ü¼¯¡£
  • PR ½¨Òé°üº¬£º
  • ±ä¸üÄÚÈÝÓ붯»úµÄÇåÎú˵Ã÷£»
  • ÊÜÓ°ÏìÄ£¿é/ÏîĿ·¾¶£»
  • ²âÊÔÖ¤¾Ý£¨dotnet test Êä³ö»òµÈ¼Û˵Ã÷£©£»
  • ¹ØÁªÈÎÎñ/Issue£¨ÈçÓУ©£»
  • ½öÔÚÐÞ¸Ä UI/¾²Ì¬Ò³Ãæ×ÊԴʱ¸½½ØÍ¼¡£