Skip to content

Commit f06762b

Browse files
committed
feat(roadmap): add initial roadmap outlining future features and sensitive content handling
1 parent e806782 commit f06762b

2 files changed

Lines changed: 35 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,21 @@ AI commit, branch, PR, and changelog generation through terminal AI CLIs.
44

55
OpenCodeCommit works as:
66
- a Rust / npm CLI (`occ`)
7-
- a terminal TUI
7+
- a terminal TUI (`occ tui`)
88
- a VS Code / VSCodium extension
99

1010
Before any prompt leaves your machine, OpenCodeCommit scans the diff locally for secrets, credential files, source maps, private keys, and other sensitive artifacts.
1111

12-
[Open VSX](https://open-vsx.org/extension/Nevaberry/opencodecommit) · [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Nevaberry.opencodecommit) · [npm](https://www.npmjs.com/package/opencodecommit) · [scoped npm alias](https://www.npmjs.com/package/@nevaberry/opencodecommit) · [crates.io](https://crates.io/crates/opencodecommit) · [GitHub](https://github.com/Nevaberry/opencodecommit)
12+
- <a href="https://open-vsx.org/extension/Nevaberry/opencodecommit"><img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/vscodium/vscodium-original.svg" width="14"> Open VSX</a>
13+
- <a href="https://marketplace.visualstudio.com/items?itemName=Nevaberry.opencodecommit"><img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/vscode/vscode-original.svg" width="14"> VS Code Marketplace</a>
14+
- <a href="https://www.npmjs.com/package/opencodecommit"><img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/npm/npm-original-wordmark.svg" width="14"> npm</a>
15+
- <a href="https://crates.io/crates/opencodecommit"><img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/rust/rust-original.svg" width="14"> crates.io</a>
16+
- <a href="https://github.com/Nevaberry/opencodecommit"><img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/github/github-original.svg" width="14"> GitHub</a>
1317

1418
## Install
1519

1620
Extension:
17-
- Search for `OpenCodeCommit` in VS Code or VSCodium
18-
- Or run `ext install Nevaberry.opencodecommit`
21+
- Search for `OpenCodeCommit` in VS Code or VSCodium marketplace
1922

2023
CLI:
2124
- `cargo install opencodecommit`

ROADMAP.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Roadmap
2+
3+
## Future Features
4+
5+
### Changelog Conflict Resolution
6+
7+
When `CHANGELOG.md` already contains the requested version, do not stop at a duplicate-version error.
8+
Use the PR timeout and the stronger, more expensive model, send both the existing changelog entry and the newly generated entry, and ask the model to return one merged Keep a Changelog block for that version.
9+
If that merge still fails, fall back to manual editing.
10+
11+
### AI-Assisted Sensitive Content Gating
12+
13+
In `config.toml`, a feature (on by default) where lines flagged as sensitive by the regex are sent to a strong/expensive model for secondary analysis. The model responds with a simple **pass** or **block** verdict.
14+
15+
- **Pass example:** `OPENAI_API_KEY="placeholder"` — the regex triggers, but the AI recognizes it as a placeholder and lets it through automatically.
16+
- **Block example:** `OPENAI_API_KEY="sk-real-key-here"` — the AI detects a real credential and blocks the commit, requiring human confirmation (same flow as the current warning prompt).
17+
18+
This sits between the regex detection and the user prompt: regex fires → AI verdict → if pass, no prompt; if block, show the existing confirmation dialog.
19+
20+
### Sensitive Content Scanning in Metadata Messages
21+
22+
Run the sensitive-content regex against commit messages, branch names, PR titles/bodies, and changelog entries — not just file diffs. Catches cases where secrets or sensitive data leak into metadata rather than code.
23+
24+
Optionally, flagged metadata can also be sent to the strong AI model for pass/block analysis, including an explanation of why the regex triggered.
25+
26+
### Faster Default Models for Basic Commits
27+
28+
Switch the default LLM models used in the standard commit flow to faster, cheaper alternatives. The current models are more capable than necessary for straightforward commit-message generation and changelog updates. By defaulting to lighter models, the basic commit path becomes noticeably quicker while keeping the stronger, more expensive models available for tasks that need them (e.g., conflict resolution, sensitive-content analysis).

0 commit comments

Comments
 (0)