Skip to content

Commit 4ad78ca

Browse files
Merge pull request #2 from aryamthecodebreaker/codex/fixmap-release-hardening
Harden FixMap MVP release readiness
2 parents ef5a2f0 + 2cd229d commit 4ad78ca

7 files changed

Lines changed: 72 additions & 18 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Aryam
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# FixMap
22

3+
[![CI](https://github.com/aryamthecodebreaker/FixMap/actions/workflows/ci.yml/badge.svg)](https://github.com/aryamthecodebreaker/FixMap/actions/workflows/ci.yml)
4+
35
FixMap is an open-source repo intelligence tool for developers using AI coding agents.
46

57
It does not try to replace Codex, Cursor, Copilot, Claude Code, or other coding tools. It helps them start in the right place, read the right files, run the right checks, and leave a clearer review trail.
@@ -87,9 +89,9 @@ That makes the project realistic to train and run with normal developer infrastr
8789
- no hosted GPU requirement
8890
- no paid API requirement for the core open-source tool
8991
90-
## Planned Architecture
92+
## Architecture
9193
92-
FixMap will start with a deterministic baseline and grow into a small trainable ranking model.
94+
FixMap starts with a deterministic baseline and can grow into a small trainable ranking model once the report format and workflow prove useful.
9395
9496
```text
9597
issue / prompt / diff / PR
@@ -101,26 +103,25 @@ repo scanner -> feature extractor -> file ranker -> test router
101103
repo map markdown + JSON report
102104
```
103105

104-
The first model will rank files and tests using lightweight features:
106+
The MVP ranks files and tests using lightweight features:
105107

106108
- path and symbol overlap with the task
107-
- dependency and import proximity
108-
- git co-change history
109109
- test naming conventions
110-
- recent failures or touched areas when available
111-
- ownership and review hotspots when available
110+
- changed-file signals from real git diffs
111+
- content overlap from lightweight file samples
112+
- nearby test naming and path overlap
113+
114+
Future releases can add dependency/import proximity, git co-change history, recent failures, and ownership or review hotspots.
112115

113116
The model artifact should be a small JSON file that can be committed, released, or regenerated in CI.
114117

115-
## Planned CLI
118+
## CLI
116119

117120
```bash
118121
fixmap plan --issue "Users cannot reset passwords"
119122
fixmap plan --diff main...HEAD
120-
fixmap scan
121-
fixmap train --from-git-history
122-
fixmap report --format markdown
123-
fixmap report --format json
123+
fixmap plan --base main --head HEAD --format json
124+
fixmap plan --issue "Users cannot reset passwords" --output fixmap-report.md
124125
```
125126

126127
## MVP Usage
@@ -136,15 +137,15 @@ node packages/cli/dist/cli.js plan --issue "Users cannot reset passwords" --form
136137

137138
The MVP scans local repository files, reads package scripts, resolves real git diff specs, ranks likely context files, suggests test routes, and renders markdown or JSON output.
138139

139-
## Planned GitHub Action
140+
## GitHub Action
140141

141-
The GitHub Action will:
142+
The GitHub Action:
142143

143144
1. inspect the pull request diff
144145
2. build or load the repo map
145146
3. rank related files and tests
146147
4. post a concise PR comment
147-
5. optionally upload a JSON artifact
148+
5. writes the same report to the step summary
148149

149150
No source code will be sent to a third-party service by default.
150151

@@ -168,9 +169,9 @@ FixMap is in early MVP development. The CLI can scan a JavaScript or TypeScript
168169
- [ ] Baseline ranker for context files and test routes
169170
- [ ] GitHub Action for pull request comments
170171
- [ ] CPU-trainable ranking model from repository history
171-
- [ ] Vercel-hosted website and playground
172+
- [x] Vercel-ready website and playground shell
172173
- [ ] Examples for popular repo types
173174

174175
## License
175176

176-
FixMap is intended to be open source. The license will be added before the first public release.
177+
FixMap is released under the MIT License. See [LICENSE](LICENSE).

package-lock.json

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,22 @@
55
"description": "Repo context, test routing, and review receipts for AI-assisted development.",
66
"license": "MIT",
77
"type": "module",
8+
"repository": {
9+
"type": "git",
10+
"url": "https://github.com/aryamthecodebreaker/FixMap.git"
11+
},
12+
"bugs": {
13+
"url": "https://github.com/aryamthecodebreaker/FixMap/issues"
14+
},
15+
"homepage": "https://github.com/aryamthecodebreaker/FixMap#readme",
16+
"keywords": [
17+
"ai-coding",
18+
"code-review",
19+
"developer-tools",
20+
"github-actions",
21+
"repo-intelligence",
22+
"testing"
23+
],
824
"workspaces": [
925
"packages/*",
1026
"apps/*"
@@ -16,7 +32,8 @@
1632
"build:action": "esbuild packages/action/src/index.ts --bundle --platform=node --target=node20 --format=esm --outfile=packages/action/dist/index.mjs --banner:js=\"import { createRequire as __fixmapCreateRequire } from 'module'; const require = __fixmapCreateRequire(import.meta.url);\"",
1733
"build:web": "npm run build -w @fixmap/web",
1834
"check:action-bundle": "npm run build:action && git diff --exit-code packages/action/dist/index.mjs",
19-
"ci": "npm run typecheck && npm test && npm run build && npm run check:action-bundle",
35+
"ci": "npm run typecheck && npm test && npm run build && npm run check:action-bundle && npm run smoke",
36+
"smoke": "node packages/cli/dist/cli.js plan --issue \"password reset fails\" --repo . --format json --output fixmap-report.json && node packages/action/dist/index.mjs",
2037
"test": "npm run test --workspaces --if-present",
2138
"typecheck": "npm run build:core && npm run typecheck --workspaces --if-present",
2239
"lint": "npm run lint --workspaces --if-present"

packages/action/package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
22
"name": "@fixmap/action",
33
"version": "0.0.0",
4+
"description": "GitHub Action wrapper for FixMap pull request reports.",
45
"private": true,
6+
"license": "MIT",
57
"type": "module",
68
"scripts": {
79
"typecheck": "tsc -p tsconfig.json --noEmit"

packages/cli/package.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
{
22
"name": "fixmap",
33
"version": "0.0.0",
4+
"description": "CLI for mapping issues and diffs to relevant files, tests, and review risks.",
5+
"license": "MIT",
46
"type": "module",
57
"bin": {
68
"fixmap": "dist/cli.js"
@@ -11,5 +13,8 @@
1113
},
1214
"dependencies": {
1315
"@fixmap/core": "0.0.0"
16+
},
17+
"engines": {
18+
"node": ">=20.11"
1419
}
1520
}

packages/core/package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
{
22
"name": "@fixmap/core",
33
"version": "0.0.0",
4+
"description": "Core repository scanner, ranker, and report renderer for FixMap.",
5+
"license": "MIT",
46
"type": "module",
57
"main": "dist/index.js",
68
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)