-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
65 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,53 @@ | ||
# 贡献指南 | ||
|
||
我们欢迎广大开发者贡献大家的智慧,让我们共同让它变得更完美. | ||
|
||
# 提 issue | ||
|
||
- 使用版本前缀:[0.1] xxxxxx | ||
- 正文请带上足够的信息,以便于大家能知道你做了什么,在什么样的场景下,出现了什么错误,并且知道 你已经尝试过但没成功的解决方法 | ||
- 只提供标题的将会被忽略。 | ||
|
||
# 贡献代码 | ||
|
||
请严格遵循以下代码标准: | ||
|
||
- [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md). | ||
- 使用 4 个空格作为缩进。 | ||
- 使用驼峰命名法 | ||
- 注释请使用英文 | ||
- 注释风格,描述与参数注释间空一行,不同类型的注释标签(如@param 与 @return)之间空一行,类型请使用带命名空间的全称(参考下面的@return),如: | ||
/** | ||
* Parse JSON from response and check error. | ||
* | ||
* @param string $method | ||
* @param array $args | ||
* | ||
* @return \Support\Collection | ||
*/ | ||
- 方法的开始 { 在新的一行 | ||
我们使用 [styleCI](https://styleci.io) 来对代码格式进行检查,在你提交 PR 后,页面下方会(评论框上面部分)会有各项检查状态,如果有一项没有通过,请点击后来的 details 修好对应的地方,直到全部通过(会有绿色的 √ 符号)。 | ||
|
||
开发流程 | ||
|
||
Fork 到本地. | ||
|
||
创建新的分支: | ||
|
||
``` | ||
$ git checkout -b new_feature | ||
``` | ||
|
||
编写代码。 | ||
|
||
Push 到你的分支: | ||
|
||
``` | ||
$ git push origin new_feature | ||
``` | ||
|
||
创建 Pull Request 并描述你完成的功能或者做出的修改。 | ||
|
||
# 报告 Bug | ||
|
||
当你在使用过程中遇到问题,请在这里提问 GitHub. 如果还是不能解决你的问题,请到 GitHub 联系我们。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# 我用的环境 | ||
|
||
- 使用的版本: | ||
- PHP 版本: | ||
- 是否使用了框架? | ||
- 框架名称: | ||
|
||
# 问题及现象 | ||
|
||
描述你的问题现象,报错贴截图粘贴或者贴具体信息,提供必要的代码段 | ||
|
||
如果你不提供相关的代码,我不会做任何应答,直接 close,感谢! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters