On a Roll

• On a Roll
  • 入门指南
    • 先决条件
    • 安装
  • 开发实践
    • 常规提交
    • 提交前钩
  • 贡献
  • 许可协议

On a Roll 是用 Rust 编写的 CLI 任务管理器，让您感觉今天一切都在顺利进行。

它使用 Diesel 进行数据库交互，并使用 SQLite 作为数据库引擎，确保轻量级和高效的数据管理。

入门指南

以下说明将帮助您将项目副本安装在本地机器上，以进行开发和测试。

先决条件

• Rust 编程语言

• SQLite

• Diesel CLI

安装

首先，克隆仓库

git clone https://github.com/donbignose/on-a-roll.git
cd on-a-roll

安装 Diesel CLI，这是处理数据库迁移所必需的

cargo install diesel_cli --no-default-features --features sqlite

通过运行 Diesel 迁移来设置数据库

diesel setup

现在，您可以为项目构建和运行

cargo build
cargo run

开发实践

常规提交

我们使用 Commitizen 并遵循常规提交规范来编写提交信息。这导致了更易于阅读且易于跟踪的项目历史记录中的消息。它还允许我们自动生成变更日志。

使用 Commitizen

我们建议使用 Commitizen 来编写提交信息。这是一个帮助您编写一致且符合常规的提交信息的工具。要使用 Commitizen，请在您的终端中运行 cz commit 而不是 git commit。该项目包含一个 .cz.toml 配置文件，以方便 Commitizen 的使用。

提交前钩

我们的项目使用预提交钩子来确保代码质量和符合标准。在提交之前，会运行代码格式化和代码检查的钩子，有助于保持代码库整洁。

设置预提交钩子

要本地设置预提交钩子，请运行以下命令

pre-commit install

此命令在您的本地仓库中设置钩子，在每个提交之前运行诸如 rustfmt 和 Clippy 之类的检查。

贡献

我们欢迎社区贡献！请在提交拉取请求之前阅读我们的贡献指南和代码行为准则。

许可协议

本项目采用 MIT 许可协议 - 有关详细信息，请参阅文件。