如何做贡献

感谢您对 AIOS 的兴趣！以下是帮助您为这个项目做出贡献的指南。

1. 开始

Fork 仓库

首先，您需要 Fork 这个仓库并创建您自己的仓库副本。

克隆仓库并安装依赖项。

使用 pip 安装依赖项

pip install -r requirements.txt

安装 pre-commit

我们强烈建议安装 pre-commit 以确保在开发期间进行适当的格式化。

2. 开发和测试

创建分支

为您的创意功能创建一个新的开发分支

git checkout -b your-feature

做出更改并测试

您可以开发新功能，然后需要确保一切按预期工作。运行我们提供的测试并确保现有的测试通过。鼓励您添加新的测试。

运行测试

如果有任何测试代码，请将其添加到 tests/ 目录中，然后通过 pytest 运行测试

pytest -s tests

3. 提交更改

代码格式检查

请确保您的代码使用 pre-commit 正确格式化。

Git 提交格式

我们强烈建议您的 git 提交遵循以下格式

git commit -m <type>: <subject>

创建拉取请求

1. 访问您在 GitHub 上 Fork 的 AIOS 仓库，并点击 “Compare & pull request” 按钮来启动将您的更改提交到原始仓库以供审查和潜在合并的过程。
2. 选择基础分支和比较分支（您的功能分支）。💡 注意，当您添加新功能时，建议选择 (dev) 分支，如果您的更改不影响原始功能，您可以考虑选择 (main) 分支。
3. 在描述中写入标题并描述您的更改。建议选择更改的标签以使其更清晰。

4. 审查和批准

我们的维护人员将审查您的提交，并可能提出一些建议或要求更多细节。一旦他们批准，您的贡献就可以被合并到 AIOS 中！