Skip to content

Add community health files and CI workflow#2

Merged
B143KC47 merged 1 commit into
mainfrom
chore/community-health
Mar 10, 2026
Merged

Add community health files and CI workflow#2
B143KC47 merged 1 commit into
mainfrom
chore/community-health

Conversation

@B143KC47

Copy link
Copy Markdown
Owner

Summary

  • add CONTRIBUTING, SECURITY, and CODE_OF_CONDUCT documents
  • add issue templates, a pull request template, and release notes config
  • add Dependabot and a GitHub Actions CI workflow
  • improve README and README.zh-CN with project health links and CI badge

Why

These changes make the repository look more mature, easier to contribute to, and easier to trust for first-time users evaluating this MCP server.

Copilot AI review requested due to automatic review settings March 10, 2026 02:03
@B143KC47 B143KC47 force-pushed the chore/community-health branch from d719fe8 to 34e6f48 Compare March 10, 2026 02:06
@B143KC47 B143KC47 merged commit caf46fd into main Mar 10, 2026

Copilot AI 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.

Pull request overview

This PR adds standard community health documentation and GitHub automation (CI, Dependabot, templates) to make the repository easier to contribute to and to signal project maturity/trustworthiness.

Changes:

  • Added community health docs: CONTRIBUTING, SECURITY, and Code of Conduct.
  • Added GitHub project hygiene: issue/PR templates, Dependabot config, and release notes config.
  • Added a GitHub Actions CI workflow and updated READMEs with health links + CI badge.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
SECURITY.md Adds a security policy and vulnerability reporting guidance.
CONTRIBUTING.md Adds contributor workflow expectations and a PR checklist.
CODE_OF_CONDUCT.md Adds conduct expectations and enforcement/reporting guidance.
README.md Adds badges/health links and refreshes onboarding + usage docs.
README.zh-CN.md Mirrors README improvements for Chinese readers.
.github/workflows/ci.yml Introduces a basic CI build workflow (Node 20 + npm ci + build).
.github/dependabot.yml Enables scheduled dependency update PRs for npm and GitHub Actions.
.github/release.yml Adds release notes categorization and a custom release template.
.github/PULL_REQUEST_TEMPLATE.md Adds a PR template with validation/security checklists.
.github/ISSUE_TEMPLATE/config.yml Disables blank issues and adds contact links.
.github/ISSUE_TEMPLATE/bug_report.md Adds a structured bug report template.
.github/ISSUE_TEMPLATE/feature_request.md Adds a structured feature request template.
Comments suppressed due to low confidence (1)

README.md:170

  • The ssh_init_config tool requires scope to be one of project or user (and project_root is required when scope=project). The parameters column here is less specific than the actual tool schema, which can lead to misconfigured client calls.
| `ssh_exec` | Execute a command on a remote host | `host`, `command`, `timeout_ms?` |
| `ssh_init_config` | Initialize SSH config file | `scope`, `project_root?`, `hosts?` |
| `ssh_get_config` | Get config for a specific host | `host` |

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment thread .github/release.yml
Comment on lines +22 to +26
exclude:
labels:
- skip-release-notes
template: |
## What's changed

Copilot AI Mar 10, 2026

Copy link

Choose a reason for hiding this comment

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

In GitHub's auto-generated release notes config, exclude and template are expected to be nested under the changelog: key. With the current indentation they will likely be ignored, so labels like skip-release-notes may not exclude PRs and the custom template may not apply.

Copilot uses AI. Check for mistakes.
Comment thread README.zh-CN.md
Comment on lines +168 to +170
[![License: MIT](https://img.shields.io/badge/license-MIT-green?style=flat-square)](LICENSE)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-3178c6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
[![MCP](https://img.shields.io/badge/MCP-compatible-6e56cf?style=flat-square)](https://modelcontextprotocol.io/)

Copilot AI Mar 10, 2026

Copy link

Choose a reason for hiding this comment

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

The ssh_init_config tool's scope parameter is constrained to project or user (and project_root is required when using project). Documenting the allowed values here would better match the actual tool schema and reduce setup confusion.

Copilot uses AI. Check for mistakes.
Comment thread README.zh-CN.md
Comment on lines +92 to +94
```

VS Code MCP 最小示例:

Copilot AI Mar 10, 2026

Copy link

Choose a reason for hiding this comment

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

This line is in English inside the Chinese README. Consider translating it (or making the surrounding section bilingual) to keep the doc language consistent.

Copilot uses AI. Check for mistakes.
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.

2 participants