大家好，我是前端之虎陈随易。

这是我的个人网站 https://chensuiyi.me。

yidash（易大师）一万个JavaScript实用方法库。

是我于2024年07月30日凌晨5点45分创建的一个仓库。

仓库地址是：https://github.com/chenbimo/yidash

文档官网：https://yidash.dev

截止2024年08月01日，一共耗时3天，目前的数据如下：

名称	值
函数数量	100个
距目标差	9900个
总耗时	3天
提交次数	307次
PR数量	64个
贡献者	22位
Star数	40个

这是一个面向所有人的函数库，不管你是开发大佬、职场高手、入行新人还是大学生。

只要你会写JS（不必会TS），能分享你的实用函数，就能参与进来。

参与过程非常简单：

1. 访问本仓库。
2. fork本仓库。
3. 拉取fork后的仓库。
4. 修改代码。
5. push代码。
6. 发起pull request到yidash官方仓库。
7. 等待笔者验证与合并。

以下是参与守则：

1. 必须写 JSDoc注释，不然别人看不懂，不知道怎么用。
2. 必须写 函数作者，标签为 @author，如 @author chensuiyi。
3. 必须写 函数别名，标签为 @alias，如 @alias yd_is_array。
4. 必须写 案例说明，标签为 @example，如 @example yd_is_array([1,2,3])。
5. 必须写 测试用例，在 test目录 下，与 lib目录 中的结构一一对应。
6. 必须 4格缩进，不喜欢的请不要参与本项目。
7. 必须按 提交主题：提交描述 写清楚提交信息。
8. 必须 一个函数一个文件，不能多个导出函数写到一个文件中。
9. 函数名称必须清楚地表达函数作用，不用晦涩难懂的单词。
10. 函数必须使用 default 默认导出，且导出的必须是一个 箭头函数。
11. 能用 const 定义的地方尽量用 const。
12. 不能使用 var 定义变量。
13. 不要炫技，用尽量简单易懂的方式，宁愿多写几行，也不要增加理解难度。
14. 尽量不要函数引入函数，每个函数尽量独立，不依赖其他函数。
15. 除导出函数外，其余函数不能使用多行注释，只能使用单行注释。
16. 一个工具函数的代码行数不超过500行（特殊情况例外）。
17. 代码风格以笔者规范为准（会进行沟通），不能擅自修改代码规范。
18. 笔者会对所有提交的代码进行审核，并根据情况增删代码。
19. 如若本项目产生收益，仓库所有者（陈随易）拥有对收益的完全支配权。
20. 如果提交代码，便视为同意以上守则，请查阅并确认后参与。

贡献者福利：

1. 增加开源参与度，体会开源的乐趣。
2. 加入交流群，与一群志同道合的人一起做有价值，有意义的事情。
3. 为自己的职业经历增加一个彩蛋，增加面试的亮点。
4. 你的函数将会被每一个使用yidash的人看到。
5. 额外获得VSCode扩展fnMap永久注册码一枚。

fnMap地址：https://marketplace.visualstudio.com/items?itemName=chensuiyi.fn-map。

1. 每个注册用户可以免费领取一个永久注册码（登录自动领取）。
2. 每个贡献者可以额外领取一个（私聊我即可，否则不会自动赠送）。

最后，感谢所有参与者，让我们一起做一件有趣、有价值、有意义的事~