如何贡献

DeepFOS项目欢迎任何形式的贡献

  • bug反馈

  • 需求建议

  • 代码贡献

  • 文档贡献

  • …

无论您是否对Python熟悉，是否有编码经验，都可以提出您宝贵的建议。所有贡献者，都将更新在项目的 贡献者名单 中

发现bug如何反馈

任何缺陷或bug都欢迎到本项目的Gitee仓库提 Issue 。

操作步骤如下：

  1. 点击新建Issue

  2. 输入框中保留 “缺陷” 小节

  3. 复制标题样式并填写标题

  4. 回答输入框中的问题

  5. 指定右侧的负责人，优先级等信息

  6. 点击“创建”提交Issue

提示

Issue格式请参考此 模板

怎样提出功能需求

功能需求同样通过Issue提出，操作步骤请参考“ 发现bug如何反馈 ” 。注意使用 需求模板 即可。

编码规范

如果您希望为本项目贡献代码，那么首先请确保您的代码符合本仓库的代码风格。我们有如下要求:

  1. 代码符合 PEP8 规范

  2. 全面使用 类型标注

  3. docstring使用 Google风格

代码提交规范及流程

向deepfos仓库提交代码，请按照以下步骤进行：

  1. 申请仓库的开发者权限

  2. 克隆仓库至本地，基于master分支新建分支

    git checkout master
git checkout -b your_branch_name

  3. 在新分支上修改您的代码，并且提交您的修改

  4. 回到Gitee，新建Pull Request，选择源分支为您的分支，目标分支为master。选择审批人并且提交。

提示

如果您的代码通过了审查，我们将合并您的代码。有时候代码可能有些小问题，并不能马上合并， 我们会在您的Pull Request中即使提出修改意见。所以请关注您提交的Pull Reuquest。