你好!很高兴你有兴趣为 插件世界
做贡献。
你的每一次提问,每一句答复,每一场批评,每一行代码,每一个插件,对我们都是无比珍贵。
欢迎你对我们的工作进行指导批评。
对此我们十分感谢,我们一定认真倾听考虑你的意见。
如遇重大问题期望进行反馈,欢迎你在互动交流的渠道中与我们取得联系。
在提交您的贡献之前,请务必花点时间阅读以下介绍:
指南 | 来源 |
---|---|
12-factors | Adam Wiggins |
约定式提交规范 | Conventional Commits |
语义化版本号 | Gravatars |
中文文档编写指南 | 唐杰 |
英文文档编写指南 | Vue.js |
::: details 查看 Commit 类型介绍
类型(可选的范畴): 简短描述
可选的详情
可选的注解
feat(auth): increase length of new API key
the length is increased from 24 to 32 for new API keys
close #12
类型 | 说明 |
---|---|
feat | feature - 所有实现新功能、新行为的 commit 都属这个类型 |
fix | 修正缺陷的 commit |
chore | 日常维护性的改动,例如 linter 的配置等 |
test | 与测试有关的改动 |
refactor | 不改变行为的对代码结构的改进 |
style | 对代码风格的修正(仅限缩进、空行一类的简单改动,对结构有影响的用 refactor) |
cosm | cosmetic - 不改变行为的对界面的纯视觉上的改动 |
docs | 对文档的改进,包括对外文档和代码注释 |
build | 和构建流程、持续集成等有关的改动 |
::: |
为了保持代码库的整洁性和一致性,务必请你一定要遵守相关语言的的编码风格。如果您对此有疑问,请阅读相关源代码。这使得我们可以专注在贡献的内容本身,而非代码风格上。请您尽量在贡献时模仿其他代码库使用的风格。
1. PHP 编码规范
2. PHP 编码约定(参考来源: Fresns)
PluginsWorld\Discussion
,而非 PluginsWorld\Discussions
)Interface
结尾(例如:MailableInterface
)Abstract
开头(例如:AbstractModel
)Trait
结尾(例如:ScopeVisibilityTrait
)state
,没有状态迁移关系使用 status
state
交通灯状态: red -> green -> yellowstatus
付款结果: success / failed3. PHP 模型约定 ::: details 查看 Model 相关代码段顺序定义
class XxxModel
{
// const 常量定义区域
// use Trait 定义区域
// static 属性定义区域
// 属性定义区域
// static 父级 Model 函数定义区域
// scope 函数定义区域
// setXxxYyyAttribute 定义区域
// getXxxYyyAttribute 定义区域
// xxxYyy(): Attribute 定义区域
// relations 关系定义区域
// 自定义函数定义区域
// 静态自定义函数定义区域
}
:::
4. 数据库风格 表 的命名规则如下:
languages
)session_tokens
)discussion_user
)字段 的命名应当根据其数据类型而定:
{动词}_at
(例如:created_at,read_at)或 {动词}_until
(例如:suspended_until){名词}_count
(例如:comment_count,word_count){动词}_{实体对象}_id
(例如:hidden_user_id)
user_id
)is_{形容词}
(例如:is_locked)1. 前端编码规范
待完善
2. 前端性能优化之雅虎35条军规
通过向 插件世界 贡献你的代码,你授予 插件世界 团队你的所有相关知识产权(包括版权、专利和任何其他权利)的非独占的、不可撤销的、全球性的、免版税的、可再许可且可转让的许可,以便我们在任何许可条款下使用、复制、准备衍生作品、分发、公开执行和展示此等贡献,包括但不限于以下条款:(a) 开放源码许可证,如 Apache-2.0 许可证;以及 (b) 二进制、专有或商业许可证。除本协议授权的许可外,你保留与此等贡献有关的所有权利、所有权和利益。
你确认,你能够授予我们这些权利。你声明,你在法律上有权授予上述许可。如果你的雇主对你所创造的知识产权拥有权利,你声明你已获得许可代表该雇主做出贡献,或者你的雇主已放弃了此等贡献的以上权利。
你声明,此等贡献是你的原创作品,而且据你所知,没有其他人主张或有权主张此等贡献有关的任何发明或专利的任何权利。你还声明,无论是通过签订协议还是其他方式,你都没有任何与本许可条款相冲突的法律义务。
插件世界 团队确认,除非本协议中有明确的描述,你提供的任何贡献都是以「现状」为基础的,不附带任何形式的无论明示或暗示的保证或条件,包括但不限于任何关于所有权、非侵权、适销性或特定用途的适用性的保证或条件。
/*
* PluginsWorld (https://gitee.com/github-mouyong/plugins-world)
* Copyright (C) 2021-Present mouyong
* Released under the MIT License.
*/
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。