提交 6923712b 编写于 作者: 梦境迷离's avatar 梦境迷离

add CONTRIBUTING

上级 f33b107f
To be a collaborator
---
When more than one person use a language which you can code (whether there are more than one person using a language can be judged according to the assessment of the issue).
* Each person creates a package for himself to distinguish different people(if sub module has exists). Refer to `java-leetcode`.
For the first time, please submit by PR, you can obtain the permission of collaborator after this PR is merged.
* Everyone creates a new one in their own package named `packageName.md`, add the index and then link it to the current sub module README.md, refer to `java-leetcode`.
If there is no language in this repository. Please submit PR to create a new sub module like follow example.
Direct push is not allowed for create a new module. And you should support `GitHub action workflows` as much as possible.
this is a python sub module, if you want to create a new module that the language you use is not exists you should look at this structure.
```
python-leetcode
/laozhang
/leetcode_12.py
/laozhang.md
/dreamylost
/leetcode_12.py
/dreamylost.md
README.md
```
edit `python-leetcode/README.md`, let's make `packageName.md` linked to `python-leetcode/README.md`, such as
```
[laozhang](./laozhang/laozhang.md)
[dreamylost](./dreamylost/dreamylost.md)
```
## requirement
* When non script language is used, it must be compiled locally. The JVM platform uses gradle spotlessApply to format the code, which is not required by script language
* No code passed GitHub action workflow, please roll back immediately! (at present, this repository only supports checking JVM language and Rust)
* If it doesn't pass sonarcloud, please roll back immediately!
* If it fails to pass lgtm, please take time to solve it
* Conflict resolution: only append is allowed, not delete
* The copyright of the default java code is: all collaborator
\ No newline at end of file
如何成为 Collaborator
---
[english](./CONTRIBUTING-en.md)
多人同时使用一种语言时(是否存在多人使用一种语言,可根据 issue 的 assiginess 来判断)
- 每个人为自己建一个package,用以区分不同人,参考 `java-leetcode`,第一次以PR形式提交,merge后你将获得Collaborator权限
- 每个人在自己package中新建一个`packageName.md`,增加题目索引再链接到当前项目的README.md
本库没有的语言,自己提PR新建子模块,参考`java-leetcode`新建模块,该操作不允许直接push,请尽可能的支持 `GitHub action workflows`(不会就忽略)
如果你要创建新的语言的子模块,应该以下面的python-leetcode项目为例
```
python-leetcode
/laozhang 每个人的包
/leetcode_12.py 每个人刷的题,这里还能创建自己的子包,区分专题
/laozhang.md 每个人的题目索引
/dreamylost
/leetcode_12.py
/dreamylost.md
README.md 聚合每个人的.md文件
```
`packageName.md`这么链接到python-leetcode的`README.md`
```
[laozhang](./laozhang/laozhang.md)
[dreamylost](./dreamylost/dreamylost.md)
```
## 要求
* 使用非脚本语言时,必须本地编译通过,JVM平台统一使用 gradle spotlessApply 格式化代码,脚本语言不作要求
* 没有通过GitHub action workflows的代码,请立刻回滚!(目前本库只支持对JVM语言和Rust的检查)
* 没有通过sonarcloud的,请立刻回滚!
* 没有通过lgtm的,请抽空解决即可
* 解决冲突: 只允许 append 不能 delete
* 默认Java代码的版权是: all Collaborator
\ No newline at end of file
...@@ -22,6 +22,8 @@ ...@@ -22,6 +22,8 @@
Just create a issue or leave a message at the end of the [dreamylost's blog](https://dreamylost.cn) Just create a issue or leave a message at the end of the [dreamylost's blog](https://dreamylost.cn)
For details, please see [CONTRIBUTING](./CONTRIBUTING-en.md)
### Way of participation ### Way of participation
 Each participating partner will get the Collaborator permission of the code repository,  Each participating partner will get the Collaborator permission of the code repository,
......
...@@ -22,6 +22,8 @@ ...@@ -22,6 +22,8 @@
提交 issue 或 [博客留言](https://dreamylost.cn) 提交 issue 或 [博客留言](https://dreamylost.cn)
详情请参见 [CONTRIBUTING](./CONTRIBUTING.md)
### 参与方式 ### 参与方式
 每位参与的小伙伴,都会获得代码仓库的 Collaborator 权限,可以自由地提交代码(不限制语种,方式参见 [issue #23](https://github.com/jxnu-liguobin/cs-summary-reflection/issues/23)),通过 issue 认领。  每位参与的小伙伴,都会获得代码仓库的 Collaborator 权限,可以自由地提交代码(不限制语种,方式参见 [issue #23](https://github.com/jxnu-liguobin/cs-summary-reflection/issues/23)),通过 issue 认领。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册