@@ -21,7 +21,7 @@ Be respectful, constructive, and inclusive. We follow the [Rust Code of Conduct]
2121
2222### Prerequisites
2323
24- - ** Rust** 1.75+ (stable toolchain recommended)
24+ - ** Rust 1.85+ ** (stable toolchain recommended)
2525- ** Git** for version control
2626- An ** LLM API key** (OpenAI, Anthropic, etc.) for testing review features
2727
@@ -47,14 +47,43 @@ cargo clippy -- -D warnings
4747```
4848cora-cli/
4949├── src/
50- │ ├── main.rs # CLI entry point
51- │ ├── cli.rs # Argument parsing (clap)
52- │ ├── config.rs # Configuration management
53- │ ├── scanner.rs # File scanning and diff generation
54- │ ├── reviewer.rs # LLM integration for code review
55- │ ├── formatter.rs # Output formatting
56- │ └── ci.rs # CI/CD integration helpers
57- ├── tests/ # Integration tests
50+ │ ├── main.rs # CLI entry point
51+ │ ├── commands/ # CLI subcommand handlers
52+ │ │ ├── mod.rs
53+ │ │ ├── review.rs # cora review
54+ │ │ ├── scan.rs # cora scan
55+ │ │ ├── upload.rs # cora upload-sarif
56+ │ │ ├── auth.rs # cora auth
57+ │ │ ├── hook_cmd.rs # cora hook
58+ │ │ ├── init.rs # cora init
59+ │ │ ├── completion.rs # cora completion
60+ │ │ └── providers.rs # cora providers
61+ │ ├── config/ # Configuration loading & schema
62+ │ │ ├── mod.rs
63+ │ │ ├── schema.rs # Config struct definitions
64+ │ │ ├── loader.rs # Config file discovery & loading
65+ │ │ └── providers.rs # Provider auto-detection
66+ │ ├── engine/ # Core review/scanning engine
67+ │ │ ├── mod.rs
68+ │ │ ├── llm.rs # LLM API client
69+ │ │ ├── review.rs # Diff review logic
70+ │ │ ├── scanner.rs # Project scanning logic
71+ │ │ └── types.rs # Shared types (Severity, Findings, etc.)
72+ │ ├── formatters/ # Output formatting
73+ │ │ ├── mod.rs
74+ │ │ ├── pretty.rs # Pretty-printed terminal output
75+ │ │ ├── compact.rs # Compact single-line output
76+ │ │ ├── json_fmt.rs # JSON output
77+ │ │ └── sarif.rs # SARIF output
78+ │ ├── git/ # Git operations
79+ │ │ ├── mod.rs
80+ │ │ ├── diff.rs # Diff generation
81+ │ │ └── files.rs # File discovery
82+ │ └── hook/ # Git hook management
83+ │ ├── mod.rs
84+ │ ├── install.rs # Hook install/uninstall
85+ │ └── template.rs # Hook script template
86+ ├── tests/ # Integration tests
5887├── Cargo.toml
5988└── README.md
6089```
@@ -68,7 +97,7 @@ cora-cli/
6897 ```
69983 . ** Make your changes** and commit with meaningful messages:
7099 ``` bash
71- git commit -s - m " feat: add support for SARIF output format"
100+ git commit -m " feat: add support for SARIF output format"
72101 ```
731024 . ** Push** to your fork and open a ** Pull Request**
74103
@@ -94,6 +123,7 @@ We follow [Conventional Commits](https://www.conventionalcommits.org/):
941234 . Ensure ` cargo clippy -- -D warnings ` is clean
951245 . Ensure ` cargo fmt ` has been applied
961256 . Keep PRs focused — one logical change per PR
126+ 7 . ** CI will automatically run cora on your PR** — all findings must be addressed or the PR will be blocked
97127
98128## Coding Standards
99129
@@ -124,8 +154,8 @@ Please open a [GitHub Issue](https://github.com/ajianaz/cora-cli/issues/new) wit
124154
125155- ** Description** — What happened vs. what you expected
126156- ** Steps to reproduce** — Minimal reproduction steps
127- - ** Environment** — OS, Rust version, cora-cli version
128- - ** Logs** — Output with ` RUST_LOG=debug cora review`
157+ - ** Environment** — OS, Rust version, cora-cli version ( ` cora --version ` )
158+ - ** Logs** — Output with ` cora --verbose review `
129159
130160## Feature Requests
131161
0 commit comments