rustere

Rust 模板仓库

描述 • 安装 • 使用方法 • 使用此模板 • 贡献

描述

rustere 代表 Rust template repository。

这是一个 Rust 的模板仓库，具有以下特性：

• :octocat: 使用 GitHub actions 进行 CI
  • 代码格式化
  • 代码检查
  • 单元测试
• 📝 问题 & PR 模板
• 🤖 陈旧机器人 & Dependabot
• 🚀 自动发布到 crates.io

安装

通过运行以下命令安装 rustere

cargo install rustere

使用方法

rustere 不包含任何有用的代码，因为它是一个模板仓库。
但是，你可以运行以下命令来检查是否正确安装了该软件包

rustere

使用此模板

要使用此模板，请点击“使用此模板”按钮

它将提示你创建一个新的 GitHub 仓库。

然后，用你的自己的包名、自己的代码替换你刚刚创建的仓库中的内容，并更新链接以指向你自己的仓库。

以下是需要完成的详尽列表

• 添加你的内容 :
  • 修改 cargo.toml : 替换包名、版本、作者、描述和主页。
  • 替换 README.md : 你可以保留相同的 README 结构，但必须更新核心内容以适应你正在构建的内容。确保将所有 astariul 替换为你的用户名，并将所有 rustere 替换为你的包名。
  • 添加你的代码 : 删除 src/main.rs 和 src/lib.rs 中的内容，并添加你自己的代码。
  • 替换测试 : 用实际测试替换 tests/integration_tests.rs 中的内容。
  • 更新 .github/ 文件夹中的名称和链接 :
    • 在 .github/ISSUE_TEMPLATE/bug.yaml 中，将 rustere 替换为您的包名。
    • 在 .github/ISSUE_TEMPLATE/config.yml 中，将 astariul/rustere 替换为您自己的 <user>/<repo>。
  • 可选：如果您不希望使用某些功能（例如自动将代码发布到 crates.io 的 Github Action），您可以将其删除！
• 启用 Dependabot：从 Github 网站进入您的仓库页面，通过访问仓库的 Settings 标签页，然后在 Security & analysis 部分启用 Dependabot，您可以启用 Dependabot alerts 和 Dependabot security updates。
• 添加您的 crates.io API 令牌：自动将您的包发布到 crates.io 的 Github Action 需要您的 API 令牌。您可以将此 API 令牌存储在 Github secret 中。
  要这样做，请访问您的 Github 仓库的 Settings 标签页，然后进入 Secrets 部分，点击 New repository secret 按钮。
  然后设置密钥的名称为 CARGO_REGISTRY_TOKEN，并将您的 API 令牌粘贴到值字段中。

贡献

要贡献，请在本地上安装包，创建自己的分支，添加您的代码（以及测试和文档），然后提交 PR！

代码格式化

确保您添加的代码格式正确

cargo fmt

测试

在贡献时，您需要确保所有单元测试通过。如果需要，还应添加测试！

您可以使用以下命令运行测试：

cargo test

文档

文档应保持最新。您可以通过运行以下命令在本地查看文档：

cargo doc --open