-
Notifications
You must be signed in to change notification settings - Fork 0
Add community health files and CI workflow #2
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
Merged
Changes from all commits
Commits
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,40 @@ | ||
| --- | ||
| name: Bug report | ||
| about: Report a reproducible problem in the SSH MCP server | ||
| title: "[Bug] " | ||
| labels: [bug] | ||
| assignees: [] | ||
| --- | ||
|
|
||
| ## Summary | ||
|
|
||
| Describe the problem in one or two sentences. | ||
|
|
||
| ## Environment | ||
|
|
||
| - OS: | ||
| - Node.js version: | ||
| - MCP client: | ||
| - Repository version / commit: | ||
|
|
||
| ## Steps to reproduce | ||
|
|
||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| ## Expected behavior | ||
|
|
||
| What should have happened? | ||
|
|
||
| ## Actual behavior | ||
|
|
||
| What happened instead? | ||
|
|
||
| ## Relevant config / logs | ||
|
|
||
| Paste sanitized snippets only. Do not include private keys, passwords, tokens, or sensitive hostnames. | ||
|
|
||
| ## Additional context | ||
|
|
||
| Anything else that helps reproduce or diagnose the issue. |
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,8 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Security issue | ||
| url: https://github.com/B143KC47/ssh_mcp/blob/main/SECURITY.md | ||
| about: Please use the security reporting process instead of a public issue. | ||
| - name: Documentation and setup guide | ||
| url: https://github.com/B143KC47/ssh_mcp#readme | ||
| about: Check the README before opening a setup or usage issue. |
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,27 @@ | ||
| --- | ||
| name: Feature request | ||
| about: Suggest a new capability or workflow improvement | ||
| title: "[Feature] " | ||
| labels: [enhancement] | ||
| assignees: [] | ||
| --- | ||
|
|
||
| ## Problem to solve | ||
|
|
||
| What workflow is currently painful or missing? | ||
|
|
||
| ## Proposed solution | ||
|
|
||
| Describe the change you want to see. | ||
|
|
||
| ## Why it matters | ||
|
|
||
| How would this help users adopt or trust the project? | ||
|
|
||
| ## Possible design notes | ||
|
|
||
| Optional: MCP API shape, SSH behavior, security constraints, or UX considerations. | ||
|
|
||
| ## Alternatives considered | ||
|
|
||
| What other approaches did you evaluate? |
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,19 @@ | ||
| ## Summary | ||
|
|
||
| Explain what changed and why. | ||
|
|
||
| ## Validation | ||
|
|
||
| - [ ] `npm run build` passed locally | ||
| - [ ] Docs/examples were updated if needed | ||
| - [ ] I considered security implications | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] This PR is focused and limited in scope | ||
| - [ ] User-facing behavior is documented | ||
| - [ ] Sensitive values are not included in logs, screenshots, or examples | ||
|
|
||
| ## Notes for reviewers | ||
|
|
||
| Anything you want reviewers to pay extra attention to. |
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,13 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: "npm" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| open-pull-requests-limit: 5 | ||
|
|
||
| - package-ecosystem: "github-actions" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "monthly" | ||
| open-pull-requests-limit: 3 |
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,32 @@ | ||
| changelog: | ||
| categories: | ||
| - title: 🚀 Features | ||
| labels: | ||
| - feature | ||
| - enhancement | ||
| - title: 🐛 Fixes | ||
| labels: | ||
| - bug | ||
| - fix | ||
| - title: 🛡 Security | ||
| labels: | ||
| - security | ||
| - title: 📝 Documentation | ||
| labels: | ||
| - documentation | ||
| - docs | ||
| - title: 🧰 Maintenance | ||
| labels: | ||
| - chore | ||
| - dependencies | ||
| exclude: | ||
| labels: | ||
| - skip-release-notes | ||
| template: | | ||
| ## What's changed | ||
|
|
||
| $CHANGES | ||
|
|
||
| ## Contributors | ||
|
|
||
| $CONTRIBUTORS | ||
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,29 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| pull_request: | ||
| branches: | ||
| - main | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20 | ||
| cache: npm | ||
|
|
||
| - name: Install dependencies | ||
| run: npm ci | ||
|
|
||
| - name: Build | ||
| run: npm run build |
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,29 @@ | ||
| # Code of Conduct | ||
|
|
||
| This project aims to be welcoming, practical, and respectful. | ||
|
|
||
| ## Expected behavior | ||
|
|
||
| - Be respectful and constructive | ||
| - Focus feedback on ideas, code, and outcomes | ||
| - Assume good intent, but communicate clearly | ||
| - Help keep discussions useful for contributors from different backgrounds and experience levels | ||
|
|
||
| ## Unacceptable behavior | ||
|
|
||
| - Harassment, insults, or personal attacks | ||
| - Hate speech or discriminatory language | ||
| - Doxxing or sharing private information without consent | ||
| - Repeated spam, trolling, or deliberately disruptive behavior | ||
|
|
||
| ## Scope | ||
|
|
||
| This applies to issues, pull requests, code review, and project discussions. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| The maintainer may edit, hide, lock, or remove content that violates these expectations and may restrict participation for repeated or severe violations. | ||
|
|
||
| ## Reporting | ||
|
|
||
| If you experience or witness a serious conduct issue, report it privately when possible. For non-sensitive moderation problems, a maintainer issue is also acceptable. |
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,53 @@ | ||
| # Contributing to SSH MCP Server | ||
|
|
||
| Thanks for considering a contribution. | ||
|
|
||
| ## Best ways to contribute | ||
|
|
||
| - Report bugs with clear reproduction steps | ||
| - Propose new MCP workflows or SSH safety features | ||
| - Improve docs, examples, and onboarding | ||
| - Submit focused pull requests with one clear goal | ||
|
|
||
| ## Before you start | ||
|
|
||
| 1. Search existing issues and pull requests first | ||
| 2. For larger changes, open an issue to discuss the use case | ||
| 3. Keep security and backwards compatibility in mind | ||
|
|
||
| ## Local development | ||
|
|
||
| ```bash | ||
| npm install | ||
| npm run build | ||
| npm run dev -- --project-root . | ||
| ``` | ||
|
|
||
| ## Project expectations | ||
|
|
||
| - Preserve the security-first design of the server | ||
| - Keep MCP tool names stable unless there is a strong reason to change them | ||
| - Prefer standard OpenSSH behavior over custom configuration formats | ||
| - Update both `README.md` and `README.zh-CN.md` when user-facing behavior changes | ||
| - Update examples when configuration or setup steps change | ||
|
|
||
| ## Pull request checklist | ||
|
|
||
| - [ ] The change solves one clear problem | ||
| - [ ] `npm run build` passes | ||
| - [ ] User-facing changes are documented | ||
| - [ ] New config or workflow behavior is reflected in examples | ||
| - [ ] Security implications were considered | ||
|
|
||
| ## Reporting security issues | ||
|
|
||
| Please do **not** open public issues for vulnerabilities. Follow the process in [SECURITY.md](SECURITY.md). | ||
|
|
||
| ## Code review style | ||
|
|
||
| Smaller, focused pull requests are reviewed faster. If a change is large, explain: | ||
|
|
||
| - the user problem | ||
| - the design tradeoffs | ||
| - the security implications | ||
| - how you verified the result |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
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,
excludeandtemplateare expected to be nested under thechangelog:key. With the current indentation they will likely be ignored, so labels likeskip-release-notesmay not exclude PRs and the custom template may not apply.