dennis zhuang
5d4699db1c
* docs: refine coding agent maps Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: trim license header guidance Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * docs: update README links and project status Signed-off-by: Dennis Zhuang <killme2008@gmail.com> --------- Signed-off-by: Dennis Zhuang <killme2008@gmail.com>
2.3 KiB
Generated Files — Do Not Hand-Edit
These artifacts are produced by tooling. Editing them by hand is almost always wrong: your change is either overwritten on regeneration or causes CI to fail. When the underlying source changes, regenerate them with the listed command.
sqlness .result files — tests/cases/**/*.result
Generated by the sqlness runner from the sibling .sql files. Never edit a
.result by hand. To update expectations, change the .sql (or the engine
behavior) and re-run the test; the runner rewrites the .result.
cargo sqlness bare # run all local cases
cargo sqlness bare -t <name> # run one case
Review the regenerated output with git diff tests.
Note: tests/cases/distributed/common is a symlink to
tests/cases/standalone/common. They are the same files — editing one changes
both, and there is no need to diff standalone vs distributed.
Configuration docs — config/config.md
Generated from the config/*.example.toml files and
config/config-docs-template.md.
make config-docs
Edit the example TOMLs and/or the template, then regenerate. Do not edit
config/config.md directly.
Grafana dashboards
For the metrics dashboards, edit
grafana/dashboards/metrics/cluster/dashboard.json. The generator derives the
standalone dashboard.json by removing instance filters, then produces
dashboard.yaml and dashboard.md for both cluster and standalone variants.
Do not hand-edit those five derived files.
grafana/dashboards/events/dashboard.json and
grafana/dashboards/logs/dashboard.json are not outputs of this generator.
make dashboards
build.rs-generated code
Some crates generate code at build time into the Cargo OUT_DIR (e.g.
common-version for build/git info, plus common-catalog, common-function's
system tables, log-store, servers). There is no checked-in file to edit —
change the corresponding build.rs or its inputs instead.
Protobuf / gRPC types
Generated from the external greptime-proto crate, not from sources in this
repo. To change the wire format, change greptime-proto upstream and bump the
dependency.
License headers
License headers are checked by korandoru/hawkeye@v5 in
.github/workflows/checks.yml. For enterprise-gated files, also update both
license lists and run make check-enterprise-license.