Skip to content

docs: change readme and contributing md #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 27, 2024
Merged

docs: change readme and contributing md #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README-zh_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ pnpm install dt-react-component
```jsx
import React from 'react';
import { BlockHeader } from 'dt-react-component';
const App = () => <BlockHeader title="分类标题" showBackground />;
const App = () => <BlockHeader title="分类标题" background />;
```

### 按需加载
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ pnpm install dt-react-component
```jsx
import React from 'react';
import { BlockHeader } from 'dt-react-component';
const App = () => <BlockHeader title="分类标题" showBackground />;
const App = () => <BlockHeader title="分类标题" background />;
```

### Load on demand
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ order: 5

1、fork 本仓库，在自己的仓库提交代码

2、请从 **master** 分支中新建 **feat** 分支进行开发，分支命名用下划线加上版本号，如：**feat\_功能**
2、请从 **master** 分支中新建 **fix** 分支进行开发，分支命名用下划线加上版本号，如：**fix\_功能**

3、**feat** 分支开发完毕后请向相应负责人提 PR，PR 要求附上自己仓库的文档预览地址，待相应负责人 review 代码后和入 **master** 分支
3、**fix** 分支开发完毕后请向相应负责人提 PR，PR 要求附上自己仓库的文档预览地址，待相应负责人 review 代码后和入 **master** 分支

## 如何生成自己的文档地址

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ pnpm install dt-react-component
```js
import React from 'react';
import { BlockHeader } from 'dt-react-component';
const App = () => <BlockHeader title="分类标题" showBackground />;
const App = () => <BlockHeader title="分类标题" background />;
```

</div>
Expand All @@ -58,7 +58,7 @@ const App = () => <BlockHeader title="分类标题" showBackground />;
*/
import React from 'react';
import { BlockHeader } from 'dt-react-component';
export default () => <BlockHeader title="分类标题" showBackground />;
export default () => <BlockHeader title="分类标题" background />;
```

</div>
Expand Down
Loading