Skip to content

Commit 5eb3d3f

Browse files
its-mashits-mash
committed
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 <mash@mcpmux.com> Signed-off-by: Mohammod Al Amin Ashik <maa.ashik00@gmail.com>
1 parent f5be2da commit 5eb3d3f

7 files changed

Lines changed: 214 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Bug Report
2+
description: Report a bug in McpMux
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for reporting a bug! Please fill out the details below.
9+
10+
- type: input
11+
id: version
12+
attributes:
13+
label: McpMux Version
14+
description: Which version are you running?
15+
placeholder: e.g. 0.1.0
16+
validations:
17+
required: true
18+
19+
- type: dropdown
20+
id: os
21+
attributes:
22+
label: Operating System
23+
options:
24+
- Windows
25+
- macOS
26+
- Linux
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: description
32+
attributes:
33+
label: What happened?
34+
description: Describe what you expected vs what actually happened.
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: steps
40+
attributes:
41+
label: Steps to reproduce
42+
description: How can we reproduce this?
43+
placeholder: |
44+
1. Open McpMux
45+
2. Go to...
46+
3. Click on...
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: logs
52+
attributes:
53+
label: Logs / Screenshots
54+
description: Paste any relevant log output or screenshots.
55+
validations:
56+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions & Help
4+
url: https://github.com/mcpmux/mcp-mux/discussions/categories/q-a
5+
about: Ask questions and get help in GitHub Discussions
6+
- name: Feature Ideas
7+
url: https://github.com/mcpmux/mcp-mux/discussions/categories/ideas
8+
about: Share and discuss feature ideas

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for suggesting a feature! Please describe what you'd like.
9+
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Problem
14+
description: What problem does this solve? What's your use case?
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: solution
20+
attributes:
21+
label: Proposed Solution
22+
description: How do you think this should work?
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Alternatives Considered
30+
description: Any workarounds or alternative approaches you've considered?
31+
validations:
32+
required: false
33+
34+
- type: textarea
35+
id: context
36+
attributes:
37+
label: Additional Context
38+
description: Any other context, screenshots, or examples.
39+
validations:
40+
required: false

‎.github/pull_request_template.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## What does this PR do?
2+
3+
<!-- Brief description of the change -->
4+
5+
## How was it tested?
6+
7+
<!-- Describe how you tested this change -->
8+
9+
- [ ] `pnpm test` passes
10+
- [ ] `pnpm lint` passes
11+
- [ ] `pnpm typecheck` passes
12+
13+
## Checklist
14+
15+
- [ ] My code follows the project's code style
16+
- [ ] I have signed off my commits (`git commit -s`)
17+
- [ ] I have updated documentation if needed

‎CODE_OF_CONDUCT.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, disability, ethnicity, gender identity and expression, level of experience,
8+
education, socio-economic status, nationality, personal appearance, race,
9+
religion, or sexual identity and orientation.
10+
11+
We pledge to act and interact in ways that contribute to an open, welcoming,
12+
diverse, inclusive, and healthy community.
13+
14+
## Our Standards
15+
16+
Examples of behavior that contributes to a positive environment:
17+
18+
* Using welcoming and inclusive language
19+
* Being respectful of differing viewpoints and experiences
20+
* Gracefully accepting constructive criticism
21+
* Focusing on what is best for the community
22+
* Showing empathy towards other community members
23+
24+
Examples of unacceptable behavior:
25+
26+
* Trolling, insulting or derogatory comments, and personal or political attacks
27+
* Public or private harassment
28+
* Publishing others' private information without explicit permission
29+
* Other conduct which could reasonably be considered inappropriate in a professional setting
30+
31+
## Enforcement Responsibilities
32+
33+
Community leaders are responsible for clarifying and enforcing our standards of
34+
acceptable behavior and will take appropriate and fair corrective action in
35+
response to any behavior that they deem inappropriate, threatening, or harmful.
36+
37+
## Scope
38+
39+
This Code of Conduct applies within all community spaces, and also applies when
40+
an individual is officially representing the community in public spaces.
41+
42+
## Enforcement
43+
44+
Instances of unacceptable behavior may be reported to the project team at
45+
**hello@mcpmux.com**. All complaints will be reviewed and investigated promptly
46+
and fairly.
47+
48+
## Attribution
49+
50+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
51+
version 2.1, available at
52+
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
44
[![GitHub release](https://img.shields.io/github/v/release/mcpmux/mcp-mux)](https://github.com/mcpmux/mcp-mux/releases)
5+
[![CI](https://github.com/mcpmux/mcp-mux/actions/workflows/ci.yml/badge.svg)](https://github.com/mcpmux/mcp-mux/actions/workflows/ci.yml)
6+
![Windows](https://img.shields.io/badge/Windows-0078D6?logo=windows&logoColor=white)
7+
![macOS](https://img.shields.io/badge/macOS-000000?logo=apple&logoColor=white)
8+
![Linux](https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black)
59

610
### Configure your MCP servers once. Connect every AI client.
711

‎SECURITY.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
|---------|-----------|
7+
| latest | Yes |
8+
9+
## Reporting
10+
11+
If you discover a security issue, please report it responsibly.
12+
13+
**Email**: hello@mcpmux.com
14+
15+
Please include:
16+
- Description of the issue
17+
- Steps to reproduce
18+
- Affected version(s)
19+
- Any potential impact
20+
21+
We will acknowledge receipt within 48 hours and aim to provide an initial
22+
assessment within 7 days.
23+
24+
## Scope
25+
26+
The following are in scope:
27+
- McpMux desktop application
28+
- McpMux gateway (localhost:45818)
29+
- Credential storage and encryption
30+
- OAuth token handling
31+
- Access key authentication
32+
33+
## Preferences
34+
35+
- Please give us reasonable time to address the issue before public disclosure
36+
- We appreciate detailed reports with clear reproduction steps
37+
- We will credit reporters (unless you prefer to remain anonymous)

0 commit comments

Comments
 (0)