Skip to content

Commit

Permalink
docs: 完善文档 (#49)
Browse files Browse the repository at this point in the history
* feat: 优化文档,测试提交pr

* perf: 优化文档说明

* feat: 尝试提交一个pr

* feat: git提交忽略.history文件夹

---------

Co-authored-by: VictorBo <hi@vtrbo.cn>
  • Loading branch information
lisuchen002 and vtrbo committed Jun 24, 2024
1 parent 4be4af0 commit 2037b2a
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 7 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@ dist-*
.idea
# .vscode

# Plugins
.history/

# Svelte
/.svelte-kit

Expand Down
16 changes: 12 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,16 @@
```
5. 代码提交
<br>
经过以上的操作,相信你已经将你的bug或者是你的idea完善了,那接下来就该提交代码了,让你的头像也出现在“参与者”中 - 第一步:提交代码
` 这个如果要让我写的话就过分了啊` - 第二步:提PR
<br/>
你以上的操作,有没有意义就全在这里了。打开你的浏览器,进入到[项目仓库](https://github.com/xparcai/xparcai-utils) - 点击Pull request - 在Compare changes下面,选择分支合并方法(第一个就是固定的主分支,第二个是你刚刚提交代码的分支)- 点击创建 pr - 剩下你自己摸索吧少年,再写文档,还不如回家做草鞋。
经过以上的操作,相信你已经将你的bug或者是你的idea完善了,那接下来就该提交代码了,让你的头像也出现在“参与者”中
- 第一步:提交代码
```
这个如果要让我写的话就过分了啊
```
- 第二步:提PR
<br/>
你以上的操作,有没有意义就全在这里了。打开你的浏览器,进入到你fork的项目中,上面的tab中有一个Pull request选项卡。
- 点击New pull request
- 你会发现有很多的下拉框,第一个是目标仓库,第二个是目标分支,第三个合并仓库(你fork的仓库),第四个是合并分支(你要合并的哪个分支)。组合起来就是,将你的合并仓库中的合并分支中的内容,合并到目标仓库的目标分支下
- 点击 Create pull request
- 剩下你自己摸索吧少年,再写文档,还不如回家做草鞋。
6. 当你的pr被作者通过后,那么,你就会发现,参与者的头像里,多了一个你,此时,你就能向你的面试官吹牛逼了,放肆大胆的吹牛逼
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<p>
你的救星,小趴菜工具库,一个轻量级的轮子集合,它来了~~~!

[使用文档介绍](https://xparcai.github.io/xparcai-utils/) | [参与文档介绍](https://xparcai.github.io/xparcai-utils/CONTRIBUTING.md)
[使用文档介绍](https://xparcai.github.io/xparcai-utils/) | [参与文档介绍](https://github.com/xparcai/xparcai-utils/blob/main/CONTRIBUTING.md)

# 特点

Expand Down Expand Up @@ -61,7 +61,8 @@ https://unpkg.com/xparcai-utils@latest
```javaScript
import { deepCopy } from 'xparcai-utils'
const obj1 = { a: '123', b: 456 }
const obj2 = deepCopy(obj) // { a: '123', b: 456 }
const obj2 = deepCopy(obj)
// { a: '123', b: 456 }
```

## **参与者**
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"type": "module",
"version": "0.0.1-beta.1",
"packageManager": "pnpm@9.3.0",
"description": "🍒 Collection of common JavaScript or TypeScript utils.",
"description": "🍒 一个使用TS构建的JS轮子库,专为CV的小趴菜们设计。",
"author": {
"name": "VictorBo",
"email": "hi@vtrbo.cn",
Expand Down

0 comments on commit 2037b2a

Please sign in to comment.