Skip to content

Latest commit

 

History

History
166 lines (91 loc) · 6.39 KB

CONTRIBUTING.md

File metadata and controls

166 lines (91 loc) · 6.39 KB

为 PaddleGame 做出你的贡献🏅

   欢迎大家对我们提出宝贵意见🥰!我们期待大家为PaddleGame做出贡献,可以是:

  • ⁉错误报告
  • 🔖讨论代码的当前状态
  • 🎯提交代码修复
  • 🧩提出新的产品和功能
  • 🕹成为维护者

  由于我们社区开发者们的共同努力,PaddleGame 运行良好,对于您贡献的每一个小改进,您都将帮助推动 AI 的前沿发展😃!

⭕提交拉取请求 (PR)⚙

  提交 PR 很容易😀!你可以通过提交pr提出新的产品和功能、提交代码修复等贡献,此处演示两种提交PR的方式:

🔻方式一:在线直接提交

  1. 选择要更新的文件

  通过在 GitHub 中单击它来选择更新。requirements.txt

  2. 点击“编辑此文件”

  该按钮位于右上角。

  3. 进行更改

  将版本从numpy < 1.24更改为 numpy < 1.25

  4. 预览更改并提交 PR

  单击**“Preview**”选项卡以验证更新,然后点击Commit changes提交更改,并按照更改内容填写日志。

  提交更改后,点击 Create pull request,创建PR。

  按要求提交后,会回到下面页面,等待代码厂库管理人员审核并通过你提交的PR。

🔻方式二:本地修改提交

  本地修改提交适合较大的改动或增加新文件、调试代码等情况,该方法要求按装Git.

  1. fork开源项目

  找到要提交PR的项目,先将该项目fork自己的代码仓。

  2. 克隆开源项目

  将需要提交PR的项目克隆到本地。

//打开CMD或者打开Git Bash Here
git clone git@github.com:user_name/PaddleGame.git

  3.创建新的分支

  提交PR时需要.为了防止在主分支上修改影响主分支代码,此处创建一个分支用于代码的修改。

cd PaddleGame // 切换到项目路径
git checkout -b mybranch //创建名为mybranch的分支
git branch //查看已经创建的分支 如图有mybranch和main两个分支
git checkout mybranch // 切换到分支

  切换好分支后就可以直接根据自己需求修改项目,如上图所示。

  4. 修改提交项目代码

  将代码修改后,执行git status 命令查看修改了哪些文件,接着使用git add 修改的文件名添加到暂存区,最后使用git commit -m "日志信息" 文件名提交到本地库。

git status // 查看库状态
git add 文件名 // 将修改的文件存放到暂存区
git commit -m "日志信息" 文件名 // 将修改的文件提交到本地库

  最后将本地项目代码提交到远程GitHub上

git push --set-upstream main mybranch

  进入GitHub项目,切换到mybranch分支,查看是否修改成功。

  切换到主分支,将分支mybranch代码合并到主分支,查看是否可以与主分支合并成功。

git checkout main // 切换到主分支
git merge mybranch  // 合并派生分支到主分支

  合并成功后,将主分支推送到代码仓。

git add .  // 将修改的文件存放到暂存区
git commit -m "日志信息" // 将修改的文件提交到本地库
git push origin main // 推送到远程仓库

  在GitHub切换到master主分支,查看是否合并成功

  4.提交pr请求

  进入自己fork的项目中,点击Pull requests

  点击Create pull requests

  最后点击Create pull request,提交后开源人将会收到你的合并请求。

  若采纳了你提交的pr,Contributors一栏将会显示你的头像 😃

⭕提交错误报告🐛

如果您发现 PaddleGame 存在问题,您可以提交错误报告!

为了更好的解决该问题,请您提供详细的问题描述以及出现问题的情况。如果你能提供错误的解决方案或者一个小的案例,这是再好不过的。针对使用中发现的各种错误,可以通过提交Issues 等待技术人员进行解决。

⭕编码规范📇

  为保证项目编码风格一致,在提交PR时,要遵守该项目编码规范。

🔻代码样式

  我们的所有代码遵循Google 开源项目风格指南,包括C/C++、Python。

  🔸C++ 风格指南:中文 English

  🔸Python 风格指南:中文 English

⭕许可证🉑

您所提交的贡献,默认您同意采用Apache-2.0 license.