37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
# Contributing
|
|
|
|
Kigi is a hard fork of [xai-org/grok-build](https://github.com/xai-org/grok-build)
|
|
(which does not accept external contributions). Kigi itself welcomes issues
|
|
and pull requests.
|
|
|
|
## Ground rules
|
|
|
|
- Toolchain is pinned by `rust-toolchain.toml` (Rust 1.97.0, edition 2024).
|
|
- Before opening a PR, make sure the CI gates pass locally:
|
|
|
|
```sh
|
|
cargo check --workspace --all-targets
|
|
cargo clippy --workspace --all-targets
|
|
cargo fmt --all --check
|
|
cargo deny check advisories
|
|
```
|
|
|
|
- No telemetry, analytics, or new outbound endpoints. The closed set of
|
|
first-party endpoints lives in `crates/codegen/kigi-env`.
|
|
- Upstream syncs are evaluated commit-by-commit and cherry-picked manually;
|
|
see the PRD §8.1 policy (`git range-diff` records the adopted set).
|
|
|
|
## Opening a pull request on git.zacharyzhang.com
|
|
|
|
Forking is disabled on this server. Open pull requests with AGit instead:
|
|
|
|
1. Register an account at https://git.zacharyzhang.com
|
|
2. Clone, commit your changes, then push to a `refs/for/<target-branch>` ref:
|
|
|
|
```bash
|
|
git clone https://git.zacharyzhang.com/ZacharyZhang-NY/Kigi-CLI.git
|
|
git push origin HEAD:refs/for/main -o topic=<short-name> -o title="<PR title>" -o description="<PR body>"
|
|
```
|
|
|
|
3. To update the pull request, push again with the same `topic`.
|