提交指南¶

参与本项目的协作需要一个 GitHub 账号（可以前往 GitHub 账号注册页面进行注册），但并不需要高超的 GitHub 技巧。

如果您想要向这份表格中提交新的内容，请参考本提交指南的内容。

提交前请注意

在提交 Pull Request 前，请先阅读本提交引导文档。

如果您不熟悉 Git 等操作，可以直接查看帮助通道来在 GitHub 网页内提交 issue 补充信息。

常规的提交信息最少仅需 2 步：1.向表格中增加信息 -> 2.(非必须但推荐)测试添加后的效果 -> 3.提交 Pull Request 更改。

您也可以考虑直接使用帮助通道，免去不熟悉的 Git 操作直接在 GitHub 网页界面中提交 issue，以此进行信息的补充。

1. 向表格中增加信息¶

首先，请登录您的 Github 账号。打开本项目的仓库链接: https://github.com/ittuann/Awesome-IntelligentCarRace ，然后在页面的右上角点击 Fork 按钮，以将本仓库分支到您的个人账号。

确保您已经克隆了最新版本的仓库，并且在正确的 main 分支上进行操作。

想要在表格中添加新的内容，仅需要直接修改项目根目录的 table.csv。

在 table.csv 表格的最后一行后，追加您想要添加的一行新条目。请确保您提交的数据格式正确，并与表单内现有条目保持一致。信息的添加即可完成。

如果您已增加了信息但没有执行下一步在本地测试添加后的效果，请在 Pull Request 内明确注明。

如果您是开源项目的维护者，希望您你能够在您的项目中添加一个徽章，以表示您的开源项目被收录在 Awesome Intelligent Car Race 合集中。

在您的项目的 README.md 文件顶部添加：

[![Awesome Intelligent Car Race](https://awesome.re/badge.svg)](https://github.com/ittuann/Awesome-IntelligentCarRace)

添加的徽章显示效果为：

为了保提交不会引入任何错误，在本地测试添加信息后的网页效果时，首先需要安装 Python 环境和依赖。

如果您的环境中能够使用 make 命令，可以直接运行以下命令来安装必要的依赖：

make install

在安装依赖后，即可在本地构建站点：

make

在构建完成后，您可以在本地查看修改后的网站效果：

make serve

最后添加git pre-commit hook，然后运行以下命令来进行代码风格检查和单元测试，即可完成提交 PR 前的全部测试：

pre-commit install

make lint
make unit-tests

如果在运行项目过程中没有出现任何报错，那就代表您成功地完成了增加信息后的测试。您也可以在本地浏览打开http://127.0.0.1:8000/Awesome-IntelligentCarRace/查看效果。

在确认所有更改都正常工作后，您可以将更改提交到您的分支，并创建一个 Pull Request，即可完成信息的补充。

项目采用 CI/CD 流程自动完成构建和部署。主网站通过 GitHub Action 实现 CI/CD 流程进行自动构建和部署至 GitHub Pages。

如果您想了解完整的工作流，可以查看本仓库的 Github Action。这里包含了整个自动化流程详细的步骤和运行记录。

项目代码覆盖率测试可在此查看: Codecov ; 项目代码质量分析请访问: Codacy ; 仓库许可证合规性扫描请查看: FOSSA

该代码文档由源代码内的信息自动生成，确保了文档随代码的更新同步保持最新状态。

此外，项目也提供了 RSS 订阅的方式，分别是默认以内容更新日期排序的RSS，和以文档创建日期排序的 feed_rss_created。您可以通过订阅 RSS 来获取项目的最新动态。

如果您不熟悉上述 Git 等操作，但依然希望为项目补充或修改信息，不用担心，我们为您提供了另外一个便捷的途径，即直接在 GitHub 网页界面中提交。

a. 提交 Issue:

b. 等待反馈:

每一个人都可以为项目做出贡献，不论您是否熟悉技术操作。感谢您的参与和支持！