Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (51 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

75 lines (51 loc) · 2.11 KB
Raw

Contributing

Commits

Please use conventional commits. PRs must also be titled in the same format.

This is so that release-plz can properly categorize things in CHANGELOG.md.

With Nix (recommended)

Requirements:

If you choose to use direnv, all you need to to is direnv allow. Otherwise, nix develop or your preferred way to activate .#devShells.default.

Optional configuration

Optionally, you may choose to read from our Cachix cache.

URL: https://jj-gh.cachix.org
Public Key: jj-gh.cachix.org-1:N1uFBMDd9znlhDa68BRqLSXYzXXJ2+WHVuwxpGxCtDo=

I also recommend setting the following repo configs for jj:

[aliases]
pr = ["util", "exec", "--", "nix", "run", ".#", "--", "pr"]

[fix.tools.treefmt]
command = ["treefmt", "--quiet", "--stdin", "$path"]
patterns = ["glob:'**/*'"]

With Rustup

Requirements:

Run rustup toolchain install in the project to download and install the Rust toolchain.

Refreshing the GitHub GraphQL schema

The GitHub GraphQL SDL is vendored at src/gh/github.graphql. To refresh it from GitHub's public docs endpoint, run from the repo root:

nix run .#fetch-schema
# or, without nix:
python3 tools/fetch-schema.py

The script also strips description docstrings so the file stays under jj's 1MiB snapshot limit. A weekly workflow does the same and opens a PR on drift.

Developing

# if you use nix, you can use these to take advantage
# of nix caches and cachix
nix build             # build the CLI
nix run .# -- pr help # run the CLI
nix flake check       # run all checks
treefmt               # format all files

# if you use nix, these will be wrapped and use nix
# build caches
cargo nextest run           # run tests (or `cargo nt` alias)
cargo clippy --all-targets  # run clippy lints
cargo check --all-targets   # run checks
cargo run -- pr help        # run the CLI