add CONTRIBUTING

renfei · May 7, 2022 · f85efb9 · f85efb9
1 parent 6f7a1f9
commit f85efb9
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+## 开源共建
+
+如果你有好的词库/词典欢迎向仓库提交。
+
+### 仓库配额限制
+
+由于 Github 对仓库配额有限制，需要您注意以下内容：
+
+* 单个文件不能超过 100MB 的大小，Github 会拒绝 Push。
+* 总仓库大小不能超过 5GB。
+
+如果您的文件超过 100MB，请联系[[email protected]](mailto:[email protected])通过网盘的方式发送给我，大文件将在发布页面进行发布[https://github.com/renfei/dict/releases](https://github.com/renfei/dict/releases)
+
+#### Gitee 码云的仓库配额限制
+
+由于 Gitee 对仓库配额有限制，当达到以下条件时，将停止在 Gitee 上的更新：
+
+* 单个文件不能超过 50MB 的大小，Gitee 会拒绝 Push。
+* 总仓库大学不能超过 500MB。
diff --git a/README.md b/README.md
@@ -29,6 +29,22 @@
 
 如果你有好的词库/词典欢迎向仓库提交。
 
+### 仓库配额限制
+
+由于 Github 对仓库配额有限制，需要您注意以下内容：
+
+* 单个文件不能超过 100MB 的大小，Github 会拒绝 Push。
+* 总仓库大小不能超过 5GB。
+
+如果您的文件超过 100MB，请联系[[email protected]](mailto:[email protected])通过网盘的方式发送给我，大文件将在发布页面进行发布[https://github.com/renfei/dict/releases](https://github.com/renfei/dict/releases)
+
+#### Gitee 码云的仓库配额限制
+
+由于 Gitee 对仓库配额有限制，当达到以下条件时，将停止在 Gitee 上的更新：
+
+* 单个文件不能超过 50MB 的大小，Gitee 会拒绝 Push。
+* 总仓库大学不能超过 500MB。
+
 ## 其他
 
 如果你需要分词工具可参考 IK Analyzer：[https://github.com/renfei/ik-analyzer](https://github.com/renfei/ik-analyzer)