Skip to content

chore: add Good First Issue template, pretest hook, and fix license field#150

Merged
utkarsh232005 merged 3 commits into
KDM-cli:mainfrom
utkarsh232005:feat/explain-mcp-coverage
Jun 8, 2026
Merged

chore: add Good First Issue template, pretest hook, and fix license field#150
utkarsh232005 merged 3 commits into
KDM-cli:mainfrom
utkarsh232005:feat/explain-mcp-coverage

Conversation

@utkarsh232005

@utkarsh232005 utkarsh232005 commented Jun 8, 2026

Copy link
Copy Markdown
Member

Summary

  • Good First Issue template — New .github/ISSUE_TEMPLATE/good-first-issue.md tailored to the Commander v14 + Vitest stack, with accurate file paths and AGPL-3.0 license guidance for contributors.
  • Pretest hook — Added "pretest": "npm run build" to package.json so npm test always rebuilds via tsup first, eliminating stale-JS test failures.
  • License fix — Changed "license" field in package.json from MIT to AGPL-3.0-only to match the actual LICENSE file.

Summary by CodeRabbit

  • Documentation

    • Updated good-first-issue GitHub template with contribution guidelines and verification steps.
  • Chores

    • Updated project license to AGPL-3.0-only.
    • Improved test workflow automation.

- Add .github/ISSUE_TEMPLATE/good-first-issue.md with Commander/Vitest stack guidance
- Add pretest script to rebuild via tsup before running vitest
- Fix license field from MIT to AGPL-3.0-only to match LICENSE file
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 8, 2026
@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@utkarsh232005, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 56 minutes and 15 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 31c9770c-4d46-4148-8adf-417d68ce721a

📥 Commits

Reviewing files that changed from the base of the PR and between 858c1bc and a463303.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/good-first-issue.md
  • src/__tests__/auth.test.ts

Warning

.coderabbit.yaml has a parsing error

The CodeRabbit configuration file in this repository has a parsing error and default settings were used instead. Please fix the error(s) in the configuration file. You can initialize chat with CodeRabbit to get help with the configuration file.

💥 Parsing errors (2)
Validation error: Invalid input: expected string, received undefined at "reviews.path_instructions[3].path"; Invalid input: expected string, received undefined at "reviews.path_instructions[3].instructions"
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
📝 Walkthrough

Walkthrough

This pull request updates project infrastructure and establishes contributor onboarding. The package.json now adds a pretest build hook to compile sources before tests run, changes the license to AGPL-3.0-only, and introduces a structured GitHub issue template for good-first-issue contributions that guides contributors through requirements, implementation, testing, and licensing practices.

Changes

Project Infrastructure and Contributor Onboarding

Layer / File(s) Summary
Project licensing and test infrastructure
package.json
Adds a pretest npm script that triggers npm run build before tests execute. Updates the package license from MIT to AGPL-3.0-only.
Good first issue contributor template
.github/ISSUE_TEMPLATE/good-first-issue.md
Provides a structured template for good-first-issue contributions, including sections for task description, expected terminal behavior, technical guidance (Commander v14.0.3, modular src/commands/, Vitest v4.1.6), local verification with npm install and npm test, and AGPL-3.0 licensing safeguard messaging.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through code so bright,
New templates guide contributors right,
With AGPL's protective shield,
And builds before tests are revealed,
This project's foundation takes flight! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes all three main changes in the pull request: adding a Good First Issue template, adding a pretest hook, and fixing the license field.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

codescene-delta-analysis[bot]

This comment was marked as outdated.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/ISSUE_TEMPLATE/good-first-issue.md:
- Line 9: Change the heading "### 📝 What needs to be done?" to the correct
incremented level—replace the three hashes with four (i.e., "#### 📝 What needs
to be done?") so the heading level follows the preceding heading and satisfies
markdownlint MD001 for that section.
- Line 33: Replace the absolute licensing sentence "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!" with a
neutral disclaimer that links to the LICENSE and notes this is not legal advice
(e.g., state the project is licensed under AGPL-3.0, include a link to LICENSE,
and add a brief “not legal advice; consult counsel” note). Update the text in
the good-first-issue contributor template where that exact sentence appears.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: b86e8b80-f488-4325-81ce-6ce46598ffe0

📥 Commits

Reviewing files that changed from the base of the PR and between 0624a8f and 858c1bc.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/good-first-issue.md
  • package.json

Comment thread .github/ISSUE_TEMPLATE/good-first-issue.md Outdated
Comment thread .github/ISSUE_TEMPLATE/good-first-issue.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
codescene-delta-analysis[bot]

This comment was marked as outdated.

@utkarsh232005 utkarsh232005 merged commit affdf86 into KDM-cli:main Jun 8, 2026
11 checks passed

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Gates Passed
3 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: The Bare Minimum
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.

@codecov

codecov Bot commented Jun 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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

Labels

documentation Improvements or additions to documentation frontend

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant