From 5eb3d3f611253cff6e0f6da76f43fc25203aaaa4 Mon Sep 17 00:00:00 2001 From: Mohammod Al Amin Ashik Date: Mon, 16 Feb 2026 10:53:09 +0800 Subject: [PATCH] chore: add community health files and README badges Add CODE_OF_CONDUCT.md (Contributor Covenant v2.1), SECURITY.md, issue templates (bug report, feature request), PR template, and CI/platform badges to README for GitHub community health score. Signed-off-by: its-mash Signed-off-by: Mohammod Al Amin Ashik --- .github/ISSUE_TEMPLATE/bug_report.yml | 56 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++++ .github/ISSUE_TEMPLATE/feature_request.yml | 40 ++++++++++++++++ .github/pull_request_template.md | 17 +++++++ CODE_OF_CONDUCT.md | 52 ++++++++++++++++++++ README.md | 4 ++ SECURITY.md | 37 ++++++++++++++ 7 files changed, 214 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..fd59b2fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,56 @@ +name: Bug Report +description: Report a bug in McpMux +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for reporting a bug! Please fill out the details below. + + - type: input + id: version + attributes: + label: McpMux Version + description: Which version are you running? + placeholder: e.g. 0.1.0 + validations: + required: true + + - type: dropdown + id: os + attributes: + label: Operating System + options: + - Windows + - macOS + - Linux + validations: + required: true + + - type: textarea + id: description + attributes: + label: What happened? + description: Describe what you expected vs what actually happened. + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: How can we reproduce this? + placeholder: | + 1. Open McpMux + 2. Go to... + 3. Click on... + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Logs / Screenshots + description: Paste any relevant log output or screenshots. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..bbecdcf2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Questions & Help + url: https://github.com/mcpmux/mcp-mux/discussions/categories/q-a + about: Ask questions and get help in GitHub Discussions + - name: Feature Ideas + url: https://github.com/mcpmux/mcp-mux/discussions/categories/ideas + about: Share and discuss feature ideas diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..48ac0175 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,40 @@ +name: Feature Request +description: Suggest a new feature or improvement +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a feature! Please describe what you'd like. + + - type: textarea + id: problem + attributes: + label: Problem + description: What problem does this solve? What's your use case? + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: How do you think this should work? + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Any workarounds or alternative approaches you've considered? + validations: + required: false + + - type: textarea + id: context + attributes: + label: Additional Context + description: Any other context, screenshots, or examples. + validations: + required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..a27d93ed --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +## What does this PR do? + + + +## How was it tested? + + + +- [ ] `pnpm test` passes +- [ ] `pnpm lint` passes +- [ ] `pnpm typecheck` passes + +## Checklist + +- [ ] My code follows the project's code style +- [ ] I have signed off my commits (`git commit -s`) +- [ ] I have updated documentation if needed diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..bca0bd25 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,52 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +education, socio-economic status, nationality, personal appearance, race, +religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior: + +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, or harmful. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. + +## Enforcement + +Instances of unacceptable behavior may be reported to the project team at +**hello@mcpmux.com**. All complaints will be reviewed and investigated promptly +and fairly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), +version 2.1, available at +https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. diff --git a/README.md b/README.md index f50bc4da..fc212a73 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE) [![GitHub release](https://img.shields.io/github/v/release/mcpmux/mcp-mux)](https://github.com/mcpmux/mcp-mux/releases) +[![CI](https://github.com/mcpmux/mcp-mux/actions/workflows/ci.yml/badge.svg)](https://github.com/mcpmux/mcp-mux/actions/workflows/ci.yml) +![Windows](https://img.shields.io/badge/Windows-0078D6?logo=windows&logoColor=white) +![macOS](https://img.shields.io/badge/macOS-000000?logo=apple&logoColor=white) +![Linux](https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black) ### Configure your MCP servers once. Connect every AI client. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..a93de2d0 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,37 @@ +# Security Policy + +## Supported Versions + +| Version | Supported | +|---------|-----------| +| latest | Yes | + +## Reporting + +If you discover a security issue, please report it responsibly. + +**Email**: hello@mcpmux.com + +Please include: +- Description of the issue +- Steps to reproduce +- Affected version(s) +- Any potential impact + +We will acknowledge receipt within 48 hours and aim to provide an initial +assessment within 7 days. + +## Scope + +The following are in scope: +- McpMux desktop application +- McpMux gateway (localhost:45818) +- Credential storage and encryption +- OAuth token handling +- Access key authentication + +## Preferences + +- Please give us reasonable time to address the issue before public disclosure +- We appreciate detailed reports with clear reproduction steps +- We will credit reporters (unless you prefer to remain anonymous)