-
Notifications
You must be signed in to change notification settings - Fork 8
chore: add Good First Issue template, pretest hook, and fix license field #150
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
utkarsh232005
merged 3 commits into
KDM-cli:main
from
utkarsh232005:feat/explain-mcp-coverage
Jun 8, 2026
+36
−2
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| name: "🚀 Good First Issue" | ||
| about: A starter task for new TypeScript / Commander contributors. | ||
| title: "[Good First Issue]: " | ||
| labels: ["good first issue", "help wanted", "typescript", "vitest"] | ||
| assignees: "" | ||
| --- | ||
|
|
||
| ## 📝 What needs to be done? | ||
| <!-- State the subcommand or flag to be added/fixed via Commander v14.0.3 --> | ||
|
|
||
| ### 🎯 Expected Behavior | ||
| <!-- Define the precise terminal command and the expected stdout/stderr output --> | ||
|
|
||
| ### 🛠️ Technical Implementation Guide | ||
| This project is modular and built on modern tooling: | ||
| 1. **CLI Layer:** We handle flags using `commander` (v14.0.3) — entry point is in `src/index.ts`. | ||
| 2. **Business Logic:** Implement your new handler or validation rules inside the respective subcommand file under `src/commands/`. | ||
| 3. **Tests:** We use `vitest` (v4.1.6) with the native fork pool to separate testing environments cleanly. Tests live in `src/__tests__/`. | ||
|
|
||
| ### 🧪 Verifying Your Work Locally | ||
| 1. Clean install your dependencies: | ||
| ```bash | ||
| npm install | ||
| ``` | ||
| 2. Run our strict test runner to ensure code coverage and logic pass perfectly: | ||
| ```bash | ||
| npm test | ||
| ``` | ||
| *(Note: This fires up `vitest run --pool=forks` with coverage via `@vitest/coverage-v8`, after automatically rebuilding the TypeScript source.)* | ||
|
|
||
| ### ⚖️ Open Source & Licensing Safeguard | ||
| This project is proudly protected under the **AGPL-3.0 License**. Because it is a standalone CLI execution tool, running, extending, or contributing to this codebase **does not** impact or "infect" your external proprietary or commercial enterprise apps. Your code remains yours, and we promise transparent attribution! | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.