Skip to content

Latest commit

 

History

History
70 lines (41 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

70 lines (41 loc) · 2.84 KB

贡献指南(ChatGPT 生成

欢迎参与我们的项目!以下是如何为这个仓库做出贡献的简单指南。请遵循以下步骤,确保您的贡献既高效又符合项目规范。

1. 复刻本仓库

首先,您需要复刻(Fork)这个仓库到您自己的 GitHub 账户。这样,您就可以在您自己的仓库中进行更改,而不会影响到原始项目。

  • 访问我们的 GitHub 页面。
  • 点击页面右上角的“复刻(Fork)”按钮。
  • 选择您想要复刻到的 GitHub 账户。

2. 创建分支并命名

在您的本地仓库中,创建一个新的分支,并以您计划修改或添加的功能命名。这样做有助于保持代码的组织性,并使代码审查过程更加清晰。

3. 本地调试

💻 设置开发环境

本软件只使用于 Windows 系统

此项目是基于 egui 构建的,请确保本地安装了Rust

同时建议您用 Visual Studio Code 进行开发。具体内容可参照 Rust 语言圣经配置。

将整个仓库代码拉到本地

请确保每个新功能都在单独的代码文件中实现,并作为模块导入到主项目中。

  • 示例:关于软件窗口,所有代码全部放于about.rs中,在ui.rs中留相关入口,在main.rs中作为模块导入

项目网站贡献

代码在pages分支中

4. 提交您的修改

在完成您的更改后,您需要将它们提交到您的分支。

  • 确保您的更改符合项目代码风格和规范。
  • 运行所有测试以确保没有引入新的错误。
  • 使用有意义的提交信息来描述您所做的更改。

5. 创建拉取请求(Pull Request)

最后,当您准备好将更改合并回主项目时,您可以创建一个拉取请求。

  • 推送您的更改到 GitHub 上的分支。
  • 点击拉取“拉取请求(Pull Request)”按钮,选择您的分支,并开始新的拉取请求。
  • 提交拉取请求。

关于分支

常驻分支

  • main: 此分支用于存放稳定的主代码,所有新功能或修复的 bug 都应先提交到 beta 分支,然后合并到 main 分支。

其他临时分支

  • beta: 测试版分支,默认提交将代码合并到此,测试无误后再合并到 main 分支
  • feat: 此分支用于提交新的功能
  • doc: 此分支专门用于修复文档, 不涉及功能改动。
  • fix: 此分支专门用于修复 dev 分支中出现的错误。
  • pages:项目网站源代码托管
  • crash: 废稿

我们的维护团队将审查您的更改,并可能提出修改建议或批准合并。感谢您的贡献,让我们一起使这个项目变得更好!