Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

向官方发起PR的注意事项(Precautions for pushing the PR to the official) #829

Open
inhere opened this issue Jul 18, 2019 · 1 comment
Labels

Comments

@inhere
Copy link
Member

inhere commented Jul 18, 2019

开发组非常欢迎各位向我们提交PR(Pull Request),但是为了保证代码质量和统一的风格,向官方的主仓库 swoft/swoft开发仓库 贡献代码时需要注意代码和commit格式

发起PR时的注意事项

  • 请不要提交PR到各个组件仓库,它们都是 只读的
  • 核心组件的 开发仓库swoft/swoft-component
  • 扩展组件的 开发仓库swoft/swoft-ext
  • fork 对应的 开发仓库,修改后,请把你的PR提交到对应的开发仓库

发布版本时官方会将代码同步到各个子仓库

Commit Message

  • commit message 只能是英文信息
  • 请尽量保证commit message是有意义的说明
  • 最好以 add: update: fix: 等关键字开头

代码风格

  • 提交的PHP代码 必须 遵循 PSR-2 代码风格
  • 合理且有意义的类、方法、变量命名
  • 适当的注释,合理的使用空行保持代码的简洁,易于阅读
  • 不要包含一些无意义的信息 例如 @author 等(提交者是能够从commit log里看到的)
@inhere inhere pinned this issue Jul 18, 2019
@inhere
Copy link
Member Author

inhere commented Jul 18, 2019

English Version (translate by Google)

The development team welcomes you to submit PR (Pull Request) to us, but to ensure code quality and uniform style, go to the official main repository swoft/swoft and Development repository, Note the code and commit format when contributing code

Precautions when initiating PR

  • Please do not submit PR to each sub-repository, they are all read-only
  • The development repository for the core components is swoft/swoft-component
  • The development repository for extension components is swoft/swoft-ext
  • Please fork the corresponding development warehouse. After modification, please submit your PR to the corresponding development warehouse.

Officially syncs code to individual sub-warehouses when new versions are released

Commit Message

  • the commit message can only be in English
  • Please try to ensure that the commit message is meaningful
  • it is best to start with the keyword add: update: fix:

Code Style

  • Submitted PHP code Must Follow PSR-2 code style
  • Reasonable and meaningful class, method, variable naming
  • Appropriate comments, reasonable use of blank lines to keep the code simple and easy to read
  • Don't include some meaningless information such as @author, etc. (author is that can be seen from the commit log)

@inhere inhere changed the title 【关于发PR】向官方发起PR时的注意事项 【关于发PR】向官方发起PR时的注意事项(Precautions when launching a PR to the official) Jul 18, 2019
@inhere inhere changed the title 【关于发PR】向官方发起PR时的注意事项(Precautions when launching a PR to the official) 【关于PR】向官方发起PR时的注意事项(Precautions when launching a PR to the official) Jul 18, 2019
@inhere inhere changed the title 【关于PR】向官方发起PR时的注意事项(Precautions when launching a PR to the official) 【关于PR】向官方发起PR的注意事项(Precautions when launching a PR to the official) Jul 18, 2019
@inhere inhere changed the title 【关于PR】向官方发起PR的注意事项(Precautions when launching a PR to the official) 向官方发起PR的注意事项(Precautions when launching a PR to the official) Jul 18, 2019
@inhere inhere changed the title 向官方发起PR的注意事项(Precautions when launching a PR to the official) 向官方发起PR的注意事项(Precautions for pushing the PR to the official) Jul 26, 2019
@inhere inhere added the notice label Sep 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant