Skip to content

Latest commit

 

History

History
170 lines (93 loc) · 6.7 KB

CONTRIBUTING_cn.md

File metadata and controls

170 lines (93 loc) · 6.7 KB

🏅为 OpenVINO™ C# API 做贡献

  欢迎大家对我们提出宝贵意见🥰!我们期待大家为 OpenVINO™ C# API 做出贡献,可以通过以下方式:

  • ⁉报告错误/问题

    如果您在 OpenVINO™ C# API 或其组件中遇到错误行为,您可以在 GitHub 问题跟踪器中创建新问题

  • 🔖提出新的产品和功能

    如果你对 OpenVINO™ C# API 有相关建议或想分享您的想法,您可以打开一个新的 Discussions GitHub 讨论。 如果您的想法已经明确定义,您还可以创建一个功能请求问题,在这两种情况下,请提供详细说明,包括用例、优势和潜在挑战。

  • 🎯修复代码错误或开发新功能

    如果您发现仓库中有代码错误或则其他内容错误,以及有新的功能或者应用案例开发,可以通过创建 Pull requests实现,再提交时,请注意代码风格以及文档风格与代码仓保持一致。

  • 🕹成为维护者

    如果你对 OpenVINO™ C# API 感兴趣,并接受该项目工作,有余力协助 OpenVINO™ C# API 库开发,可以与我联系guojin_yjs@cumt.edu.cn

⭕提交拉取请求 (PR)

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

🔻方式一:在线直接提交

  1. 选择要更新的文件

  通过在 GitHub 中单击它来选择更新,以README.md文件为例:

2. 点击“编辑此文件”

  该按钮位于右上角。

如果你没有Fork该项目,需要先Fork该项目。

  3. 修改文件内容

  增加两个🥰符号。

  修改完文件内容后,点击Commit changes提交更改,并按照更改内容填写日志。

  4. 创建 Pull Request

  修改完该文件后,修改内容只存在于修改者当前分支,需要通过 Pull Request 提交到原作者仓库才可以。点击 Create pull request,创建PR。

  按要求提交后,等待代码仓库管理人员审核并通过你提交的PR。

🔻方式二:本地修改提交

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

1. fork开源项目

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

2. 克隆开源项目

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

//打开CMD或者打开Git Bash Here
git clone https://github.com/guojin-yan/OpenVINO-CSharp-API.git

3.创建新的分支

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

cd OpenVINO-CSharp-API // 切换到项目路径
git checkout -b temp //创建名为temp的分支
git branch //查看已经创建的分支 如图有temph和csharp3.0两个分支
git checkout temp // 切换到分支

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

4. 修改提交项目代码

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

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

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

git push --set-upstream origin temp

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

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

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

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

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

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

4.提交pr请求

  进入自己fork的项目中,点击下方所指使的位置。

  点击Create pull requests

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

⭕编码规范

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

🔻代码样式

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

  🔸C++ 风格指南:English

⭕许可证

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