Skip to content

Conversation

@jwmatthews
Copy link
Member

@jwmatthews jwmatthews commented Oct 22, 2025

The intent of this PR is to reduce confusion for new contributors who land at this repo and want to contribute to Kai.
We want to inform that the majority of the Kai specifics have evolved to now exist in Typescript at https://github.com/konveyor/editor-extensions

For someone just looking at content of code in repo, I moved the older code to an archived directory. This way it's available as a reference for anyone interested while still obvious it's not currently used.

The other changes in this are:

  • There is a 1 line change to the top level Makefile to ensure the dist directory exists, I happened to see this when I verified I could build both kai_analyzer_rpc and kai_mcp_solution_server after the "git mv" of the older files.
  • Small change to README.md to point folks to editor-extensions
  • Small change to CONTRIBUTOR.md to point folks to editor-extensions

Summary by CodeRabbit

  • Documentation

    • Streamlined contributing guide by trimming setup, testing, and dependency-run instructions; added detailed commit sign-off/licensing (DCO) guidance.
    • Revised README navigation and updated project evolution notes.
  • Chores

    • Simplified build and run workflow targets and added a pre-build step to ensure distribution output exists.
    • Consolidated legacy development/demo automation into an archived workflow and broadened lint ignore scope to include archived content.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 22, 2025

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title accurately reflects the primary changes in the changeset. The title identifies two main aspects: "Archiving old content" (evidenced by the new archived/Makefile, removal of old targets from the root Makefile, and cleanup of the trunk.yaml ignore rules) and "minor doc updates to communicate most Kai dev work now happens in editor-extensions" (reflected in the CONTRIBUTING.md, README.md, and related documentation changes). The title is specific, concise, and clearly communicates the central purpose of redirecting contributors to the current development location while preserving historical code as reference material. The emoji is used thematically and appropriately without adding noise.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 14805da and a48776d.

📒 Files selected for processing (2)
  • .trunk/trunk.yaml (1 hunks)
  • README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • README.md
  • .trunk/trunk.yaml

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (1)
archived/Makefile (1)

46-52: Address the same pipeline failure: Missing ./example/analysis directory.

This get-analyzer-deps target has the same failure as noted in the main Makefile. The target attempts to copy files into ./example/analysis, which doesn't exist. This causes CI/CD pipeline failures. Verify the directory structure and either create it or exclude these targets from the CI/CD pipeline.

🧹 Nitpick comments (1)
archived/Makefile (1)

1-72: Consider adding .PHONY declarations (optional).

While the Makefile is functionally correct, adding .PHONY declarations for all targets would improve maintainability. This helps make/build tools recognize which targets are not files. While the static analysis hints suggest this, it's a low-priority enhancement for an archived file.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 70bec0e and a734cd7.

⛔ Files ignored due to path filters (1)
  • archived/docs/contrib/images/kai-rpc-server-has-been-spawned.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • CONTRIBUTING.md (1 hunks)
  • Makefile (1 hunks)
  • README.md (1 hunks)
  • archived/Makefile (1 hunks)
🧰 Additional context used
🪛 checkmake (0.2.2)
archived/Makefile

[warning] 1-1: Missing required phony target "all"

(minphony)


[warning] 1-1: Missing required phony target "clean"

(minphony)


[warning] 1-1: Missing required phony target "test"

(minphony)

🪛 GitHub Actions: Build and Publish Binaries
Makefile

[error] 41-41: get-analyzer-deps failed: './example/analysis' could not be found on the host: no such file or directory

archived/Makefile

[error] 41-41: get-analyzer-deps failed: './example/analysis' could not be found on the host: no such file or directory

🪛 markdownlint-cli2 (0.18.1)
CONTRIBUTING.md

151-151: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (6)
Makefile (2)

24-26: Approve: Necessary pre-build directory creation.

The mkdir -p dist step ensures the dist directory exists before copying the compiled binary. This is a good defensive practice and aligns with the build flow.


23-26: The review comment incorrectly identifies the failing Makefile target.

While the pipeline does fail due to missing ./example/analysis directory, the culprit is not the build-kai-analyzer target shown in lines 23-26. The actual problems are in:

  • set-binaries-demo (line 37): attempts to move binary to example/analysis/kai-analyzer-rpc
  • get-analyzer-deps (lines 40-46): attempts to copy container files into ./example/analysis
  • get-rulesets (line 50): attempts to cd into and work within example/analysis

The build-kai-analyzer target (lines 23-26) is unrelated—it only creates a dist/ directory and builds a Go binary without referencing the missing example/analysis directory.

The pipeline failure should be addressed by either creating the example/ directory structure at the repository root, making these targets conditional for CI/CD only, or updating references to point to ./archived/example/analysis.

Likely an incorrect or invalid review comment.

README.md (1)

59-64: Approve content, fix bare URL formatting.

The updated Learn More section and new paragraph about Kai's evolution to TypeScript are clear and helpful. However, the URL on line 64 should be wrapped in angle brackets to comply with markdownlint.

Wrap the URL in angle brackets to fix the MD034 violation:

- Kai began as a Python project in this repository, yet over time it has evolved to be mostly based on Typescript now and as such the majority of the Kai source code exists in the [konveyor/editor-extensions](https://github.com/konveyor/editor-extensions) repository.  This repository contains some related components such as the kai_mcp_solution_server and kai_analyzer_rpc.
+ Kai began as a Python project in this repository, yet over time it has evolved to be mostly based on Typescript now and as such the majority of the Kai source code exists in the [konveyor/editor-extensions](<https://github.com/konveyor/editor-extensions>) repository.  This repository contains some related components such as the kai_mcp_solution_server and kai_analyzer_rpc.
CONTRIBUTING.md (2)

150-151: Approve simplified setup guidance, fix bare URL formatting.

The pruning of detailed setup guidance is appropriate for archived content, with clear redirection to the active editor-extensions repository. The enhanced DCO section provides necessary compliance guidance. However, line 151 has a bare URL that should be formatted with angle brackets or wrapped in a link.

Wrap the bare URL in angle brackets or convert it to a proper link:

- The majority of Kai's development has moved to Typescript in the VSCode extension at https://github.com/konveyor/editor-extensions
+ The majority of Kai's development has moved to Typescript in the VSCode extension at <https://github.com/konveyor/editor-extensions>.

154-183: LGTM: Clear and thorough DCO guidance.

The enhanced DCO section provides comprehensive sign-off instructions with clear examples for both manual and automated approaches. This is valuable for contributors unfamiliar with the DCO requirement.

archived/Makefile (1)

1-15: Approve: Well-organized local development workflow.

The archived Makefile effectively preserves the previous development workflow with clear environment variable setup and well-commented targets. The MacOS fork-safety workaround (line 19) and comprehensive build/run targets provide good local development support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant