开发者

Contful致力于开源开发，邀请大家携手合作，共同构建一个透明、安全且人人可用的内容管理产品的典范。

贡献意向

可以发送邮件至 opensource@reepu.com 帮助我们了解你的意向和个人信息，Contful 团队将在 5 个工作日内联系你。

在提交意向和成为我们的一员之前，请务必先阅读以下的行为准则和协作规范指南。

行为准则

这里有一份 行为准则 希望你能在任何时候都严格遵守，帮助维护良好的协作与讨论氛围。

透明的开发

Contful 目前的工作都以 issue 的形式在 Gitee 上进行。不管是核心团队的成员还是外部贡献者的 pull request 都需要经过同样流程的 review。

Issue 反馈

Contful 使用 Gitee issues 进行 bug 报告和新 feature 建议。 在报告 bug 之前，请确保已经搜索过类似的 问题，因为它们可能已经得到解答或正在被修复。 对于已存在的 issue，你可以提供想法参与讨论或者评论认领后着手开始处理，仅仅评论 “+1” 并不能帮助问题得到快速解决。

对于 bug 反馈和新 feature，我们都提供了相应的 issue 模板，请尽量完善所有信息并提供在线样例，这能让 issue 得到快速响应。

发现任务

各仓库下有很多打了 help wanted 的 label 的 issue，都是初步经过筛选能够复现的 Bug 或是正在招募贡献者参与的 feature，你可以点击这个标签筛选出所有 help wanted 的 issue。

Pull Request

Fork 仓库

请将仓库 fork 至个人空间后再 clone 至本地，官方仓库有权限限制，除 PMC 成员外其他同学不能提交代码或新建分支。

创建 PR

在同步官方仓库代码后，请从 Contful 仓库均以 main 作为默认最新的开发分支）创建新的 feat/fix 分支：feat 指代新特性如新组件或者组件新功能，日常问题修复以 fix 开头。

提交代码

提交代码时按以下格式描述提交代码：

git add .
git commit -m "feat: button commit message (#1)"
git push origin feat/xxx

commit message 撰写请参照 Angular Commits 规范，一般来说 commit 信息将遵照下面的约定：

• feat : 新功能 (#issues编号)
• fix : 修复bug (#issues编号)
• docs : 文档改变
• style : 代码格式改变
• refactor : 某个已有功能重构
• perf : 性能优化
• build : 改变了build工具
• revert : 撤销上一次的 commit
• chore : 构建过程或辅助工具的变动

为什么要关联 issue？

PR 信息填写完整后就可以点击确认发起本次 PR，这会触发一系列 CI 环节在远端执行 npm run lint 及 npm run test 等。