Add community health files and CI workflow#2
Conversation
d719fe8 to
34e6f48
Compare
There was a problem hiding this comment.
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_configtool requiresscopeto be one ofprojectoruser(andproject_rootis required whenscope=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.
| exclude: | ||
| labels: | ||
| - skip-release-notes | ||
| template: | | ||
| ## What's changed |
There was a problem hiding this comment.
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.
| [](LICENSE) | ||
| [](https://www.typescriptlang.org/) | ||
| [](https://modelcontextprotocol.io/) |
There was a problem hiding this comment.
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.
| ``` | ||
|
|
||
| VS Code MCP 最小示例: |
There was a problem hiding this comment.
This line is in English inside the Chinese README. Consider translating it (or making the surrounding section bilingual) to keep the doc language consistent.
Summary
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.