spr ·
spr是一个命令行工具,用于从可能被修改和变基的本地Git提交中提交和更新GitHub拉取请求。拉取请求可以堆叠,以便对相互依赖的代码进行一系列代码审查。
spr的发音为/ˈsuːpəɹ/,类似英语单词"super"。
文档
完整文档可在此处获取:https://getcord.github.io/spr/
安装
二进制安装
使用Homebrew
brew install spr
使用Nix
nix-channel --update && nix-env -i spr
使用Cargo
如果你已安装Cargo(Rust构建工具),可以通过运行以下命令安装spr:
cargo install spr
从源代码安装
spr使用Rust编写。你需要Rust工具链来从源代码构建。如果你的系统上还没有Rust工具链,请参阅rustup.rs获取有关如何安装Rust的信息。
设置好Rust后,克隆此仓库并运行cargo build --release
。spr二进制文件将位于target/release
目录中。
快速入门
要使用spr,请在GitHub支持的Git仓库的本地检出中运行spr init
。你将被要求提供GitHub PAT(个人访问令牌),spr将使用它来调用GitHub API以创建和合并拉取请求。
要提交拉取请求,运行spr diff
。
如果你想对拉取请求进行修改,修改你的本地提交(和/或变基)并再次调用spr diff
。更新现有拉取请求时,spr会要求你提供一条简短的消息来描述更新。
要压缩合并一个开放的拉取请求,运行spr land
。
有关spr命令和选项的更多信息,运行spr help
。有关特定spr命令的更多信息,运行spr help <命令>
(例如spr help diff
)。
贡献
如果你发现问题,请随时在GitHub上提交issue。如果你甚至可以提供修复,请提出拉取请求!
如果有更大的变更或功能你想开发,请先在GitHub上提出issue进行讨论。
许可证
spr采用MIT许可证。