CONTRIBUTING.md 3.1 KB
Newer Older
sinat_25235033's avatar
sinat_25235033 已提交
1
Contributing to Sureness
sinat_25235033's avatar
sinat_25235033 已提交
2
=======================================
sinat_25235033's avatar
sinat_25235033 已提交
3 4
Very welcome to Contribute this project, go further and better with sureness.
Firstly, thanks for your interest in contributing! I hope that this will be a pleasant first experience for you, and that you will return to continue contributing.  
sinat_25235033's avatar
sinat_25235033 已提交
5

sinat_25235033's avatar
sinat_25235033 已提交
6 7 8 9 10
Components of Repository:
- [sureness's kernel code--sureness-core](https://github.com/usthe/sureness/tree/master/core)
- [sureness integration springboot sample(configuration file scheme)--sample-bootstrap](https://github.com/usthe/sureness/tree/master/sample-bootstrap)
- [sureness integration springboot sample(database scheme)-sample-tom](https://github.com/usthe/sureness/tree/master/sample-tom)
- [sample projects using sureness in each framework(javalin,ktor,quarkus)--samples](https://github.com/usthe/sureness/tree/master/samples)  
sinat_25235033's avatar
sinat_25235033 已提交
11

sinat_25235033's avatar
sinat_25235033 已提交
12
## How to contribute?  
sinat_25235033's avatar
sinat_25235033 已提交
13

sinat_25235033's avatar
sinat_25235033 已提交
14 15 16
Most of the contributions that we receive are code contributions, but you can
also contribute to the documentation or simply report solid bugs
for us to fix.
sinat_25235033's avatar
sinat_25235033 已提交
17

sinat_25235033's avatar
sinat_25235033 已提交
18
For new contributors, please take a look at issues or pull requests with a tag called below.  
sinat_25235033's avatar
sinat_25235033 已提交
19

sinat_25235033's avatar
sinat_25235033 已提交
20 21 22
[Good first issue](https://github.com/usthe/sureness/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)    
[Help wanted](https://github.com/usthe/sureness/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)     
[Good first pull request](https://github.com/usthe/sureness/issues?q=label%3A%22good+first+pull+request%22+)     
sinat_25235033's avatar
sinat_25235033 已提交
23

sinat_25235033's avatar
sinat_25235033 已提交
24
## Join discussion      
sinat_25235033's avatar
sinat_25235033 已提交
25

sinat_25235033's avatar
sinat_25235033 已提交
26 27
[Github Discussion](https://github.com/usthe/sureness/discussions)      
[Gitter Channel](https://gitter.im/usthe/sureness)          
sinat_25235033's avatar
sinat_25235033 已提交
28

sinat_25235033's avatar
sinat_25235033 已提交
29 30
----   
----   
sinat_25235033's avatar
sinat_25235033 已提交
31

sinat_25235033's avatar
sinat_25235033 已提交
32 33
参与贡献  
=======================================
sinat_25235033's avatar
sinat_25235033 已提交
34

sinat_25235033's avatar
sinat_25235033 已提交
35
非常欢迎参与项目贡献,我们致力于维护一个互相帮助的快乐社区。
sinat_25235033's avatar
sinat_25235033 已提交
36

sinat_25235033's avatar
sinat_25235033 已提交
37 38 39 40 41
仓库的组成部分:
- [sureness的核心代码--sureness-core](https://github.com/usthe/sureness/tree/master/core)    
- [使用sureness集成springboot搭建权限项目(配置文件方案)--sample-bootstrap](https://github.com/usthe/sureness/tree/master/sample-bootstrap)    
- [使用sureness集成springboot搭建权限项目(数据库方案)--sample-tom](https://github.com/usthe/sureness/tree/master/sample-tom)   
- [各个框架使用sureness的样例项目(javalin,ktor,quarkus)--samples](https://github.com/usthe/sureness/tree/master/samples)    
sinat_25235033's avatar
sinat_25235033 已提交
42 43


sinat_25235033's avatar
sinat_25235033 已提交
44
## 如何贡献?
sinat_25235033's avatar
sinat_25235033 已提交
45

sinat_25235033's avatar
sinat_25235033 已提交
46
我们不仅仅接收代码的贡献提交,您也可以通过提交文档的更新或者BUG的报告来参与社区贡献。
sinat_25235033's avatar
sinat_25235033 已提交
47

sinat_25235033's avatar
sinat_25235033 已提交
48
如果是新的贡献者,请首先了解参考如下样例的提交Issues,提交Pull Requests如果工作。
sinat_25235033's avatar
sinat_25235033 已提交
49

sinat_25235033's avatar
sinat_25235033 已提交
50 51 52
[Good first issue](https://github.com/usthe/sureness/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)    
[Help wanted](https://github.com/usthe/sureness/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)     
[Good first pull request](https://github.com/usthe/sureness/issues?q=label%3A%22good+first+pull+request%22+)
sinat_25235033's avatar
sinat_25235033 已提交
53

sinat_25235033's avatar
sinat_25235033 已提交
54 55 56 57 58 59
## 加入交流      
 
[Github Discussion](https://github.com/usthe/sureness/discussions)         
[Gitter Channel](https://gitter.im/usthe/sureness)    
QQ交流群:390083213    
微信公众号:sureness