soul源码阅读(十九)如何成为贡献者

目录

如何成为贡献者?

提交issue

说明

举例

开发流程

创建分支

编码

提交PR

保持关注,持续沟通


如何成为贡献者?

整体来说就是在github上找到你要解决的issue,或者创建issue,然后回复以表明当前正在这个issue上工作,然后创建分支,开发后提交pr。

提交issue

说明

  • 在提交issue之前,请经过充分的搜索,确定该issue不是通过简单的检索即可以解决的问题。
  • 查看issue列表,确定该issue不是一个重复的问题。
  • 新建一个issue并选择您的issue类型。
  • 使用一个清晰并有描述性的标题来定义issue。
  • 根据模板填写必要信息。
  • 在提交issue之后,对该issue分配合适的标签。如:bug report,feature request,question,task等。
  • 请对自己提交的issue保持关注,在讨论中进一步提供必要信息。

举例

点击new issue按钮,弹出如下页面:

选择合适的标签,如bug report,点击get started后,弹出页面的内容模板如下:

## Describe the bug
<!--
A clear and concise description of what the bug is.
-->

## Environment

- Soul version(s): [e.g. 2.2.1]

## Steps to reproduce


## Expected behavior
<!--
A clear and concise description of what you expected to happen.
-->

## Debug logs
<!--
Add your debug logs here.
-->

<details>
<summary>Click to expand</summary>

```
replace this line with your debug logs
```
</details>

然后就是根据模板详细描述你的bug,描述期望发生的事情以及提供bug日志,以下是一个示例。

开发流程

创建分支

fork soul源码到自己的仓库,然后下载自己仓库的源码到本地,创建本次要处理的issue的分支。

git pull upstream master
git checkout -b issueNo

注意 :PR会按照squash的方式进行merge,如果不创建新分支,本地和远程的提交记录将不能保持同步。

编码

写完issue的相关功能后,提交代码,正常备注,然后提交到issueNo的分支即可,小乌龟提交也行。

git add 修改代码
git commit -m 'commit log'
git push origin issueNo

提交PR

发送一个pull request到soul的master分支,然后替换下issueNo提交即可,示例截图如下

保持关注,持续沟通

持续关注自己的issue处理情况,会有导师给回复,如我的示例,是要求提供exception stack,当然最后是remove bug了,因为shiro-spring-boot-web-starter引入了shiro-core了,虽然第一次没成功贡献一血,但也基本尝试并弄清楚了整个流程,所以收获还是不小的。

猜你喜欢

转载自blog.csdn.net/he_cha_bu/article/details/113620218