docs: add contribution section

docs: move issue id to beginning of list
2023-05-08 18:02:14 +01:00 · 2023-05-08 18:02:04 +01:00
1 changed files with 13 additions and 2 deletions
--- a/README.MD
+++ b/README.MD
@ -12,8 +12,19 @@ pnpm start

 数据传输: 生成 blob url (`URL.createObjectURL`) 然后透过 `postMessage` 传递给线程，线程利用 `fetch` API 来获取文件信息。

+## 贡献代码
+
+欢迎贡献代码。请确保：
+
+- 单元测试的覆盖率不低于主分支的覆盖率；
+- 提交前请使用 Prettier 对代码进行格式化；
+- 提交前请确保 ESLint 不会报告 warning / error；
+
+满足上述条件后发起 Pull Request，仓库管理员审阅后将合并到主分支。
+
 ## TODO

- [ ] 文件拖放 (利用 `react-dropzone`?) #6
+- [ ] #6 文件拖放 (利用 `react-dropzone`?)
 - [ ] 各类算法 [追踪 `crypto` 标签](https://git.unlock-music.dev/um/um-react/issues?labels=67)
- [ ] 简易元数据编辑器 #7
+- [ ] #7 简易元数据编辑器
+- [ ] #8 添加单元测试
Author	SHA1	Message	Date
Jixun Wu	d2ffba5495	docs: add contribution section	2023-05-08 18:02:14 +01:00
Jixun Wu	0348347ba7	docs: move issue id to beginning of list	2023-05-08 18:02:04 +01:00