Skip to content

Latest commit

ย 

History

History
347 lines (277 loc) ยท 20.2 KB

contribution.en-us.md

File metadata and controls

347 lines (277 loc) ยท 20.2 KB

CONTRIBUTING

Chinese | English

Contribution

๐Ÿ™‹ Before contributing, please read the following information

Hello! Welcome to DK-plus!

I'm glad that you are interested in contributing to DK-plus. Before submitting your contribution, please take some time to read the following guidelines. This will help us collaborate better, avoid unnecessary work, and save everyone's time.

๐Ÿšซ No direct copying

As we all know, there are many existing component libraries in the market. Often, the components we need to develop have already been created by other third-party libraries. However, please refrain from directly copying and using source code from other libraries.

The development of a component library itself is a process of learning and progress. It's not just about adding components for the sake of adding them. We hope that participants can learn something and improve their skills while adding new components. If you encounter difficulties with a specific feature during the development phase, you can initiate a discussion or directly contact me or seek help in the group. Of course, it's also acceptable to learn from and reference other open-source libraries. However, we expect you to have a solid understanding of the problem and tackle it by yourself when writing the code.

If you have any specific questions or need further guidance on how to contribute, please let me know. I'm here to assist you.

๐Ÿ› ๏ธ Getting Started

Before contributing, you need to get the project up and running so that you can better understand its structure and how to develop it.

  • Install node, version >= 16
  • Install pnpmthe latest version is recommended.

If you have completed the previous preparations, you can skip ahead and start from here:

  • Fork dk-plus

  • Clone your fork to your local machine.

๐Ÿ“– Directory Structure

โ”œโ”€โ”€ .github     # github้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ .husky      # ไปฃ็ ๆไบคๅ‰ๆฃ€ๆต‹
โ”œโ”€โ”€ .vscode     # vscode้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ build       #ๆ‰“npmๅŒ…ๅทฅ็จ‹ๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ utils   # ๆ‰“ๅŒ…ๅทฅๅ…ท้…็ฝฎ
โ”œโ”€โ”€ โ”œโ”€โ”€ component.ts  #ๆ–‡ไปถ่พ“ๅ‡บ้…็ฝฎ
โ”œโ”€โ”€ โ”œโ”€โ”€ full-component.ts #ๆ‰“ๅŒ…ๆ–‡ไปถ่พ“ๅ‡บ่ฟ‡ๆปค่ฎพ็ฝฎ
โ”œโ”€โ”€ โ”œโ”€โ”€ gen-types.ts      #gulpfile่ฎพ็ฝฎ
โ”œโ”€โ”€ โ”œโ”€โ”€ gulpfile.ts       #ๆ‰“ๅŒ…ๅฏๅŠจๆ–‡ไปถ
โ”œโ”€โ”€ โ””โ”€ packages.ts       #ไธ“้—จๆ‰“ๅŒ…util ๏ผŒ ๆŒ‡ไปค ๏ผŒ hook็š„
โ”œโ”€โ”€ coverage   #ๆต‹่ฏ•่ฆ†็›–็Ž‡
โ”œโ”€โ”€ deploy          # ่ฟœ็จ‹ๅ‘ฝไปคSSHไธŠไผ ๅˆฐๆœๅŠกๅ™จ้…็ฝฎ
โ”œโ”€โ”€ โ”œโ”€โ”€ config.js   # ่ฟœ็จ‹ๅ‘ฝไปคSSHไธŠไผ ๅˆฐๆœๅŠกๅ™จ้…็ฝฎ
โ”œโ”€โ”€ โ”œโ”€โ”€ index.sh   # ่ฟœ็จ‹ๅ‘ฝไปคSSHไธŠไผ ๅˆฐๆœๅŠกๅ™จ้…็ฝฎ
โ”œโ”€โ”€ docs   #ๆ–‡ๆกฃ้กน็›ฎ
โ”œโ”€โ”€ โ”œโ”€โ”€ .vitepress  #ๆ–‡ๆกฃ้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ cache     #ๆœฌๅœฐ่ฟ่กŒ็ผ“ๅญ˜ๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ data  #ๆ–‡ๆกฃ้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  description.ts  #่ฏดๆ˜Žๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  expansionNav.ts #ๆ‰ฉๅฑ•ๅฏผ่ˆชๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  header.ts  #ๅคด้ƒจmeat ๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  nav.ts  #ๅฏผ่ˆชๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ””โ”€  sidebar.ts #ไพง่พนๆ ๅฏผ่ˆชๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ dist  #ๆ‰“ๅŒ…ๅŽ็š„ๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ json  #ๆ–‡ๆกฃ้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€   contribution.json #่ดก็Œฎ่€…ๅๅ•ๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€   friendlyLinks.json  #ๅ‹ๆƒ…้“พๆŽฅๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ””โ”€  home.json          #้ฆ–้กตๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ plugins #ๆ–‡ๆกฃ้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€   index.ts  #ๆ–‡ๆกฃ้…็ฝฎไธปๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€   plugin-module.ts #ๅˆ›ๅปบ markdown ๅฎžไพ‹
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ””โ”€    set-style.ts     #่ฎพ็ฝฎๆ–‡ๆกฃๆ ทๅผ(่‹ฑๆฐๅˆถไฝœ)
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ theme   #่‡ชๅฎšไน‰ไธป้ข˜
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ components  #่‡ชๅฎšไน‰ไธป้ข˜ๆ–‡ไปถๅคน
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ””โ”€ home.vue  #ไธป้กตๆ ทๅผๆ’ๆงฝ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ style  #่‡ชๅฎšไน‰ไธป้ข˜ๆ ทๅผๆ–‡ไปถๅคน
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ global.scss #ๅ…จๅฑ€ๆ ทๅผ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ home.scss   #ไธป้กตๆ ทๅผ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ””โ”€ vitepress.scss    #่œๅ•ๆ ทๅผ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ””โ”€ config.ts   #ๆ–‡ๆกฃ้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ expansion  #ๆ–‡ๆกฃๆ‰ฉๅฑ•ๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  Flutter #Flutterๆ–‡ๆกฃๆ‰ฉๅฑ•ๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  โ”œโ”€โ”€ FlutterDome  #Flutter Dome
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  โ”œโ”€โ”€ โ””โ”€ structure.md #Flutter Dome็ป“ๆž„
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  โ”œโ”€โ”€ ios #iosๆ–‡ๆกฃๆ‰ฉๅฑ•ๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  โ”œโ”€โ”€  โ”œโ”€โ”€ installXcode  #ๅฎ‰่ฃ…XcodeIOS
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  โ”œโ”€โ”€  โ””โ”€  createProject  #ๅˆ›ๅปบ้กน็›ฎ IOS ไธญ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  โ”œโ”€โ”€ windows #windowsๆ–‡ๆกฃๆ‰ฉๅฑ•ๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  โ”œโ”€โ”€  โ”œโ”€โ”€ fvmInstall  #ๅฎ‰่ฃ…fvm
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  โ”œโ”€โ”€  โ”œโ”€โ”€ WinInstall  #ๅฎ‰่ฃ…vscode ๆ’ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  โ”œโ”€โ”€  โ””โ”€  AndroidInstall #ๅฎ‰่ฃ…Android Studio
โ”œโ”€โ”€ โ”œโ”€โ”€ node_modules  # ้กน็›ฎไพ่ต–
โ”œโ”€โ”€ โ”œโ”€โ”€ index.md   #ๆ–‡ๆกฃ้ฆ–้กต
โ”œโ”€โ”€ โ”œโ”€โ”€ package.json  #ๆ–‡ๆกฃไพ่ต–ๆ–‡ไปถ
โ”œโ”€โ”€ โ””โ”€  vite.config.ts #ๆ–‡ๆกฃ้กน็›ฎ่ฎพ็ฝฎ
โ”œโ”€โ”€ images          # ่ฟœ็จ‹ๅ›พ็‰‡ๅค‡ไปฝ
โ”œโ”€โ”€ logo   #ๅ›พๆ ‡logo
โ”œโ”€โ”€ node_modules    # ้กน็›ฎไพ่ต–
โ”œโ”€โ”€ npm #npmๅŒ…้กน็›ฎ
โ”œโ”€โ”€ โ””โ”€  dist #ๆ‰“ๅŒ…ๅŽ็š„ๆ–‡ไปถ
โ”œโ”€โ”€ packages        # ็ป„ไปถๅบ“็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ components    # ๅญ˜ๆ”พๆ‰€ๆœ‰็š„็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ _hooks        # hooks
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ _directive     # ่‡ชๅฎšไน‰ๆŒ‡ไปคไปฃ็ 
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ loading   # loading ๆŒ‡ไปค
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€get-button  # ่Žทๅ–ๆŒ‰้’ฎ็š„ๆ–นๆณ•(hooks_dk-button)
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€get-Global  # ่Žทๅ–ๅ…จๅฑ€็š„ๆ–นๆณ•(hooks_ๅŒ…ๅซ็ป„ไปถ็ฑปๅž‹_็ป„ไปถๅฑžๆ€ง)
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ public       # ๅ…ฌๅ…ฑ็š„hooksๆ–นๆณ•
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  get-color  #้ขœ่‰ฒๅค„็†ๅŠ ๆทฑ ๅ‡ๆทก
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  get-props  #่Žทๅ–็ป„ไปถ็š„props
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  get-Global   #่Žทๅ–็ป„ไปถprops็š„size | type ๅ€ผ็ป™ๅฎš้ป˜่ฎคๅ€ผ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  get-props    #่Žทๅ–็ป„ไปถprops string ็ฑปๅž‹็š„ๅ€ผ ๅ’Œobj็ฑปๅž‹็š„ๅ€ผ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  get-return   #ๆ‰ง่กŒๆ–นๆณ•ๅ‡ฝๆ•ฐ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  get-ripples  #ๆŒ‡ๅฎšๅ…ƒ็ด ๅ†…็š„็‚นๅ‡ปๆœช็Ÿฅ ไธบ็‰นๆฎŠ็ป„ไปถๅฎšๅˆถๆ’ๅ…ฅๅ…ƒ็ด  ไพ‹ๅฆ‚dk-button ๆฐดๆณข็บนๆ•ˆๆžœ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  get-StyleList    #็”จไบŽ่Žทๅ–propsๅ†…ๅ‚ๆ•ฐๆ นๆฎ่ฎพ็ฝฎ็”Ÿๆˆๅฏนๅบ”ๅ็งฐ็š„class ่Žทๅ–ไผ ๅ…ฅ็š„ๆ ทๅผๆ•ฐ็ป„ๆจกๅผ็š„ๅ€ผ่งฃๆž  ๅˆคๆ–ญๆ˜ฏๅฆไธบๆ ทๅผๆทปๅŠ ๅ•ไฝ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€  set-size     #็ฎ€ๆ˜“็‰ˆๆ˜ฏๅฆๅˆคๆ–ญ้œ€่ฆๆทปๅŠ ๅ•ไฝ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€index.ts    # hooksๅ‡บๅฃๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ _icon     # ๅญ˜ๆ”พๆ‰€ๆœ‰็š„ๅ›พๆ ‡ๅŠจๆ€็ป„ไปถ็š„ๅœฐๆ–น
โ”œโ”€โ”€ โ”œโ”€โ”€ _interface    # ้กน็›ฎๅ†…็š„ๆŽฅๅฃๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ _tokens       # ้กน็›ฎๅ†…็š„้ป˜่ฎคๅ€ผ่ฎพ็ฝฎ
โ”œโ”€โ”€ โ”œโ”€โ”€ _utils        # ็ป„ไปถๅ†…็”จ็š„ๅทฅๅ…ทๆ–นๆณ•
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ index.ts      # ็ป„ไปถๅ†…ๅทฅๅ…ทๅ‡บๅฃๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ props         # ็ป„ไปถๅ†…propsๆŽจๆ–ญๆ–นๆณ•
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ typeof        # ็ป„ไปถๅ†…typeofๆ•ฐๆฎ็ฑปๅž‹ๅˆคๆ–ญๆ–นๆณ•
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ filtration    # ้ฉผๅณฐ่ฝฌๆขไธบ็Ÿญๆจช็บฟๅ‘ฝๅ  ๅฐ†ๆ•ฐๅญ—ๅฐบๅฏธๆ”นไธบๅญ—็ฌฆไธฒ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ test          # ็ป„ไปถๅ†…ๆต‹่ฏ•ๆ–นๆณ•
โ”œโ”€โ”€ โ”œโ”€โ”€ dkbutton  #ๆŒ‰้’ฎ็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ dkcodedisplay #ไปฃ็ ๅฑ•็คบ็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ dkcontainer   #้กต้ขๅธƒๅฑ€็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ dkfooter      #้กต้ขๅธƒๅฑ€็ป„ไปถ-ๅบ•้ƒจ็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ dkheader      #้กต้ขๅธƒๅฑ€็ป„ไปถ-ๅคด้ƒจ็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ dkicon        #ๅ›พๆ ‡็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ dkinput       #่พ“ๅ…ฅๆก†็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ dkinputNumber #่พ“ๅ…ฅๆก†็ป„ไปถๆŒ‰้’ฎ
โ”œโ”€โ”€ โ”œโ”€โ”€ dklaside      #้กต้ขๅธƒๅฑ€็ป„ไปถ-ๅทฆไพง็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ dkloading     #ๅŠ ่ฝฝไธญๆŒ‡ไปค็”จ็š„็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ dkmain        #้กต้ขๅธƒๅฑ€็ป„ไปถ-ไธญ็บงๅธƒๅฑ€
โ”œโ”€โ”€ โ”œโ”€โ”€ dkshadow  #็›’ๆจกๅž‹้˜ดๅฝฑ็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ dkalert   #่ญฆ็คบ็ป„ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ index.ts  #็ป„ไปถๅ…ฅๅฃๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€ utils         # ๅญ˜ๆ”พๅทฅๅ…ทๆ–นๆณ•
โ”œโ”€โ”€ โ”œโ”€โ”€ theme-chalk   # ๅญ˜ๆ”พๅฏนๅบ”็š„ๆ ทๅผ,ๆ ทๅผๆ‰“ๅŒ…ๅทฅๅ…ท็ฎฑ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ src       # ๅญ˜ๆ”พๅฏนๅบ”็š„ๆ ทๅผ
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ mixins  # ๅ…จๅฑ€classๅ‘ฝๅ็”Ÿๆˆๆ–นๆณ•
โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ โ”œโ”€โ”€ configuration # ็งๆœ‰็ป„ไปถๆ ทๅผ้…็ฝฎ
โ”œโ”€โ”€ โ””โ”€  โ””โ”€ gulpfile.ts # ๆ‰“ๅŒ…ๅทฅๅ…ท
โ”œโ”€โ”€ โ”œโ”€โ”€ dk-setup-name      #  ๆ นๆฎๅ‘ฝไปค็”Ÿๆˆ็ป„ไปถๆ–‡ไปถๅคน ๆš‚ๆœชๅฎž็Žฐ
โ”œโ”€โ”€ โ”œโ”€โ”€ dk-eslint          #  ้กน็›ฎๅ†…็š„eslint้…็ฝฎ
โ”œโ”€โ”€ โ”œโ”€โ”€ dk-plus         # ๅ‡บๅฃๆ–‡ไปถ
โ”œโ”€โ”€ โ””โ”€ utils           # ้กน็›ฎๆ‰“ๅŒ…่พ…ๅŠฉๅ™จ
โ”œโ”€โ”€ play      # ็ป„ไปถ่ฐƒ่ฏ•ๆต‹่ฏ•้กน็›ฎ
โ”œโ”€โ”€ โ”œโ”€โ”€  node_modules  # play็š„ไพ่ต– ๆต‹่ฏ•็›ฎๅฝ•
โ”œโ”€โ”€ โ”œโ”€โ”€  router        # ่ทฏ็”ฑ้…็ฝฎ
โ”œโ”€โ”€ โ”œโ”€โ”€  typings       # ts็š„ๅฃฐๆ˜Žๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€  views         # ้กต้ขๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€  app.vue       # vue app็š„ๅ…ฅๅฃๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€  index.html    # index.html  ้ฆ–้กต็š„html
โ”œโ”€โ”€ โ”œโ”€โ”€  main.ts       # main.ts     ็จ‹ๅบๅ…ฅๅฃๆ–‡ไปถ
โ”œโ”€โ”€ โ”œโ”€โ”€  package.json  # package.json  ้กน็›ฎๅ…ฅๅฃ้…็ฝฎ
โ”œโ”€โ”€ โ””โ”€  vite.config.ts  # vite ่ฝป้‡็บงๅฏๅŠจ้กน
โ”œโ”€โ”€ typings        #  ts็š„ๅฃฐๆ˜Žๆ–‡ไปถ
โ”œโ”€โ”€ โ””โ”€ vue-shim.d.ts # typescript ๅฃฐๆ˜Žๆ–‡ไปถ
โ”œโ”€โ”€ .lintstagedrc   # lint-staged ้…็ฝฎๆ–‡ไปถๆไบคๅ‰ๆฃ€ๆต‹
โ”œโ”€โ”€ .markdownlint.json # markdownlint ้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ .eslintignore   #ESLint ๅŽปๅฟฝ็•ฅ็‰นๅฎš็š„ๆ–‡ไปถๅ’Œ็›ฎๅฝ•
โ”œโ”€โ”€ .eslintrc.js    #ESLint ้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ .gitignore      # git ่ฟ‡ๆปค่ฏดๆ˜Žๆ–‡ไปถ
โ”œโ”€โ”€ .markdownlint.json # markdownlint ้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ .prettierrc.js  # Prettier ้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ .prettierignore  # Prettier ่ฟ‡ๆปค่ฏดๆ˜Žๆ–‡ไปถ
โ”œโ”€โ”€ .npmrc          # npm ้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ contribution.en-us.md # ่ดก็Œฎ่ฏดๆ˜Žๆ–‡ไปถ่‹ฑๆ–‡็‰ˆ
โ”œโ”€โ”€ contribution.md # ่ดก็Œฎ่ฏดๆ˜Žๆ–‡ไปถไธญๆ–‡็‰ˆ
โ”œโ”€โ”€ CUpdateLog.en-US.md # ๆ›ดๆ–ฐๆ—ฅๅฟ—่‹ฑๆ–‡็‰ˆ
โ”œโ”€โ”€ CUpdateLog.md # ๆ›ดๆ–ฐๆ—ฅๅฟ—ไธญๆ–‡็‰ˆ
โ”œโ”€โ”€ LICENSE         # ๅผ€ๆบๅ่ฎฎ
โ”œโ”€โ”€ README.md       # ้กน็›ฎ่ฏดๆ˜Žๆ–‡ไปถ
โ”œโ”€โ”€ README.en-US.md # ้กน็›ฎ่ฏดๆ˜Žๆ–‡ไปถ่‹ฑๆ–‡็‰ˆ
โ”œโ”€โ”€ package.json    # ้กน็›ฎ้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ pnpm-lock.yaml  # pnpm้…็ฝฎๆ–‡ไปถ
โ”œโ”€โ”€ pnpm-workspace.yaml #pnpm้…็ฝฎๆ–‡ไปถ
โ””โ”€  tsconfig.json # TS้…็ฝฎๆ–‡ไปถ

Next execute the command:

# clone ้กน็›ฎ
git clone https://github.com/dk-plus-ui/dk-plus-ui.git

# ่ฟ›ๅ…ฅ้กน็›ฎ็›ฎๅฝ•
cd dk-ui

# ๅฎ‰่ฃ…ไพ่ต–้กน
pnpm install

ps: Note that the federation directive is referenced here

If the cnpm is not installed, install the cnpm first

Foreign user package.json scripts ้‡Œ็š„ postinstall ๅ‘ฝไปค cnpm install --no-save @commitlint/[email protected] @commitlint/[email protected] ๆ”นไธบ npm install --no-save @commitlint/[email protected] @commitlint/[email protected]

# CNPMๅฎ‰่ฃ…
npm install -g cnpm --registry=https://registry.npm.taobao.org

# ๅฏๅŠจๅผ€ๅ‘้กน็›ฎ
pnpm dev:play

# ๅฏๅŠจๆ–‡ๆกฃ
pnpm dev:docs

๐Ÿ”ง Develop tools and plug-ins

Please read first IDE ๆ”ฏๆŒ

The editor is highly recommended Visual Studio Code๏ผŒPlease be sure to install the following plug-ins:

๐Ÿ”“ Command description

dk-plus Internally set up a lot of commands in package.json Is available for viewing. Each command is described in detail below:

script fields Corresponding command Command description
dev:play pnpm -C play dev Start the test development project
build:play pnpm -C play build Package test development projects
build gulp -f build/gulpfile.ts Packaging component library
dev:docs pnpm -C docs dev:docs Start the development documentation project
build:docs pnpm -C docs build:docs Package development documentation projects
format prettier --write "*/.{ts,tsx,js,json,css,scss,json,md,vue,yml,yaml}" Project code formatting
deploy:docs cross-env NODE_ENV=docs node ./deploy test
test vitest Test process
coverage vitest run --coverage Generate test logs
lint pnpm lint Project code review
prepare pnpm prepare Run cell tests

๐Ÿšจ Development specification

The main source files are all there packages Directory, where each subdirectory has a separate README.md For a description of the specified directory, refer to the following documents for detailed specifications of each module:

โš ๏ธ Submission specification

Git allows us to commit each time, with a commit information as a description when executed commit When, you need to fill in the description information in strict accordance with the specification below, the submission information must be one of the following information, followed by 'English colon + space

The type must be one of the following and be entered against the type description.

type Give an example Description
build git commit -m 'build: ๆ‰“ๅŒ…***้…็ฝฎ' Modifying the packaging configuration
ci git commit -m 'ci: ไฟฎๆ”น ci ้…็ฝฎ' Modifying ci Configuration
docs git commit -m 'docs: ไฟฎๆ”นๆ–‡ๆกฃ' Modify a document
feat git commit -m 'feat: ๆ–ฐๅขž***็ป„ไปถ' New component
fix git commit -m 'fix: ไฟฎๅค***bug' Fix bugs
perf git commit -m 'perf: ไผ˜ๅŒ–***ๆ€ง่ƒฝ' Optimized performance
refactor git commit -m 'refactor: ้‡ๆž„***ไปฃ็ ' Refactoring code
style git commit -m 'style: ไฟฎๆ”น***ๆ ทๅผ' Modify style
test git commit -m 'test: ๆ–ฐๅขž***ๆต‹่ฏ•็”จไพ‹' Added test cases
revert git commit -m 'revert: ๅ›žๆปš***ไปฃ็ ' Rollback code
chore git commit -m 'chore: ไฟฎๆ”น***้…็ฝฎ' Modify configuration
release git commit -m 'release: ๅ‘ๅธƒ***็‰ˆๆœฌ' Release version
hooks git commit -m 'hooks: ๆ–ฐๅขž*** exploit
perfect git commit -m 'perfect: ๅฎŒๅ–„*** ' Perfect previous code block Where code block
utils git commit -m 'utils: ็ป„ไปถๅทฅๅ…ท็ฎฑ*** Update toolbox
interface git commit -m 'interface: ๅขžๅŠ ็ป„ไปถๅ…จๅฑ€ๆŽฅๅฃ*** Global interface
deps git commit -m 'deps: ไพ่ต–ๅ‡็บง Dependent upgrade

Available by Markdown Emoji Add emoticons after "message"

โœ๏ธ About PR

Before you commit PR, make sure that your fork repository is up to date to avoid conflicts.

  1. Clone the remote repository to the local:
git clone <repository-url>
  1. Add a remote repository:
git checkout -b <branch-name>
  1. Make modifications and submit to local warehouse:
git add .
git commit -m 'feat: ๆ–ฐๅขž***็ป„ไปถ'

4.Push a branch to a remote repository

```shell
git push origin <branch-name>
```
  1. Create a PR in the remote repository On a code hosting platform like GitHub or GitLab, find the branch you just pushed and create a PR. You can provide details about the changes you have made and any other comments about PR in the PR.

6.Pending review and consolidation: Once your PR is submitted, team members will review and discuss your code and may suggest changes. Once all issues have been resolved and approved, your PR will be merged into the main branch.

Matters needing attention: Before submitting your PR, make sure your local branch is based on the latest main branch. PR commits should be as small as possible, and each PR should contain only one set of related changes. This makes auditing easier and also makes the code easier to maintain.

Add a description to your PR to let other developers know about the changes you've made and their purpose

๐Ÿ“ฆ NPM Release process

1.Log in to your npm account

npm login

2.publish

npm publish

๐Ÿ“ฐ Financial support

If you feel that dk-plus has helped you, you can ask the author for a cup of coffee to encourage you.

๐Ÿ’Œ Thank you very much

Thanks for all that has been done DK-plus People who contribute๏ผ