Skip to content

Latest commit

 

History

History
169 lines (112 loc) · 5.88 KB

CONTRIBUTING.en-US.md

File metadata and controls

169 lines (112 loc) · 5.88 KB
Raw

CONTRIBUTING

English documents are not synchronized in time most of the time. Please refer to Chinese documents for details.

English | Chinese

Write in front

👋 Hello! Welcome use Fighting Design!

I am glad that you are interested in contributing to Fighting Design. Before submitting your contribution, be sure to take a moment to read the following guidelines.

There may be many specifications, but most of them are small specifications. Please read them carefully.

Start project

Before you make a contribution, you need to run the Fighting Design project. Then you need to:

  • Install node,version >= 16
  • Install pnpm,the latest version is enough

If you are ready, you can skip directly and start from here:

Next, execute the command:

# Enter project directory
cd fighting-design

# Install dependencies
pnpm i

# Start development project
pnpm start

Command description

There are many commands set in Fighting Design,You can see in package.json:

"scripts": {
 "clean": "rimraf dist",
  "start": "pnpm run -C start dev",
  "dev:docs": "pnpm run -C docs dev",
  "build": "pnpm clean && vite build && pnpm build:theme && pnpm move",
  "build:theme": "vite build --config vite.config.theme.ts",
  "build:docs": "pnpm run -C docs build",
  "build:start": "pnpm run -C start build",
  "move": "node script/moveFile.ts",
  "test": "vitest",
  "prettier": "prettier --write .",
  "commit": "cz"
},

下面详细介绍每一条命令

# 清除 dist
pnpm clean

# 启动开发测试项目
pnpm start

# 启动文档项目
pnpm dev:docs

# 打包（主要的打包，打包之后就是需要发布的包）
pnpm build

# 打包组件样式主题
pnpm build:theme

# 打包文档
pnpm build:docs

# 运行打包后的文档
pnpm serve:docs

# 打包开发测试项目
pnpm build:start

# 单元测试
pnpm test

# 代码格式化
pnpm prettier

# 启用提交插件
pnpm commit

Development specification

The main source files are in the fighting-design/packages directory, and each subdirectory has a separate README.md describes the specified directory. Refer to the following documents for detailed specifications of each module:

The detailed specifications are listed in the following links. Do not ignore the following links!!!

The following is about the document specification:

Commit specification

Git allows us to attach a submission information as a description each time we submit. When we execute a commit, we 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 the colon + space + information in English

For example:

git commit -m 'feat: Add XXX function'

The type must be one of the following types and filled in against the type description.

type describe
build build
chore Change the construction process or add dependent libraries, tools, etc
ci Ci related changes
docs Document change
feat new function
fix repair
perf performance optimization
refactor Code changes that neither fix errors nor add features
revert Release new version
style Tag, space, format, missing semicolon
test Add test / test case

However, Fighting Design has built-in commitlint plug-in to assist us in adding submission information, so we need to execute the following commands:

git add .

# Use the prompt of the plug-in to set the submission information
pnpm commit

git push

About PR

Before you submit PR, please make sure that your fork warehouse is the latest code to avoid conflicts.

Therefore, before submitting PR, please be sure to pull the latest code, pull the latest code, and pull the latest code!

Common problem

Please refer to COMMON_PROBLEM

You can also contact me directly

Financial contribution

Development is not easy, welcome to sponsor!

Thank a lot

Thank all those who have contributors to Fighting Design!