Skip to content

Commit 5fb3a02

Browse files
committed
docs: prepare mcp-stacks for public release
Add comprehensive documentation and community files: - Add MIT License - Enhance README with executive-level positioning and "Why This Matters" section - Add comprehensive SECURITY.md with best practices and vulnerability reporting - Create GitHub issue templates (bug report, feature request, question) - Significantly expand CONTRIBUTING.md for external contributors Changes include: - Executive positioning highlighting GitOps, security-first architecture, and production resilience - Clear note about example hostnames (jabba.lan) for user customization - Security policy with responsible disclosure guidelines - Contribution workflow, coding standards, and testing guidelines - Community engagement and recognition policies These changes prepare the repository for open-source collaboration while maintaining security best practices. Part of public showcase preparation initiative.
1 parent e1cc840 commit 5fb3a02

File tree

7 files changed

+754
-5
lines changed

7 files changed

+754
-5
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
A clear and concise description of what the bug is.
11+
12+
## To Reproduce
13+
Steps to reproduce the behavior:
14+
1. Go to '...'
15+
2. Run command '....'
16+
3. See error
17+
18+
## Expected Behavior
19+
A clear and concise description of what you expected to happen.
20+
21+
## Actual Behavior
22+
What actually happened instead.
23+
24+
## Environment
25+
**Deployment Type:** (Agent / Edge / Both)
26+
**Operating System:** (e.g., Ubuntu 24.04, Windows 11, macOS)
27+
**Docker Version:** (output of `docker --version`)
28+
**Portainer Version:** (e.g., CE 2.19.4)
29+
**Stack/Compose File:** (e.g., stacks/desktop/docker-compose.yml)
30+
31+
## Logs
32+
```
33+
# Paste relevant logs here (docker logs, Portainer logs, etc.)
34+
# Remove any sensitive information
35+
```
36+
37+
## Screenshots
38+
If applicable, add screenshots to help explain your problem.
39+
40+
## Additional Context
41+
Add any other context about the problem here (network configuration, firewall rules, previous working state, etc.).
42+
43+
## Attempted Solutions
44+
Have you tried any workarounds or fixes? Please describe them here.
45+
46+
## Checklist
47+
- [ ] I have searched existing issues to ensure this hasn't been reported
48+
- [ ] I have included relevant logs (with sensitive info removed)
49+
- [ ] I have provided clear reproduction steps
50+
- [ ] I am using the latest version from the main branch
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an enhancement or new feature
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
A clear and concise description of the feature you'd like to see.
11+
12+
## Problem Statement
13+
Is your feature request related to a problem? Please describe.
14+
Example: "I'm always frustrated when..."
15+
16+
## Proposed Solution
17+
Describe the solution you'd like. Be as detailed as possible.
18+
19+
## Alternatives Considered
20+
Have you considered any alternative solutions or features? Please describe them.
21+
22+
## Use Case
23+
Explain how this feature would be used in a real-world scenario.
24+
25+
## Benefits
26+
What benefits would this feature provide?
27+
- **Performance:** Does it improve speed/efficiency?
28+
- **Security:** Does it enhance security posture?
29+
- **Usability:** Does it make things easier to use?
30+
- **Scalability:** Does it enable larger deployments?
31+
32+
## Implementation Suggestions
33+
If you have ideas about how this could be implemented, share them here.
34+
(Code snippets, architecture diagrams, links to similar implementations, etc.)
35+
36+
## Scope
37+
**Deployment Type:** (Agent / Edge / Both / Not Applicable)
38+
**Component:** (Scripts / Compose Files / Documentation / CI/CD / Other)
39+
**Complexity:** (Low / Medium / High - your best guess)
40+
41+
## Additional Context
42+
Add any other context, screenshots, or examples about the feature request here.
43+
44+
## Community Interest
45+
Would others in the community benefit from this feature? Please describe the potential audience.
46+
47+
## Checklist
48+
- [ ] I have searched existing issues/PRs to ensure this hasn't been proposed
49+
- [ ] I have provided a clear use case
50+
- [ ] I have considered alternatives
51+
- [ ] I am willing to help implement this (optional)

.github/ISSUE_TEMPLATE/question.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Question
3+
about: Ask a question about usage, configuration, or best practices
4+
title: '[QUESTION] '
5+
labels: question
6+
assignees: ''
7+
---
8+
9+
## Question
10+
What would you like to know?
11+
12+
## Context
13+
What are you trying to accomplish? Providing context helps us give better answers.
14+
15+
## What I've Tried
16+
Have you searched the documentation or tried any solutions? Please describe what you've done so far.
17+
18+
### Documentation Reviewed
19+
- [ ] README.md
20+
- [ ] [SECURITY.md](../../SECURITY.md)
21+
- [ ] [CONTRIBUTING.md](../../CONTRIBUTING.md)
22+
- [ ] [docs/PIPELINE.md](../../docs/PIPELINE.md)
23+
- [ ] [docs/ROADMAP.md](../../docs/ROADMAP.md)
24+
- [ ] Existing GitHub Issues
25+
26+
## Environment (if applicable)
27+
**Deployment Type:** (Agent / Edge / Both / Planning Phase)
28+
**Operating System:** (e.g., Ubuntu 24.04, Windows 11, macOS)
29+
**Portainer Version:** (e.g., CE 2.19.4)
30+
31+
## Additional Information
32+
Any other details that might be relevant to your question.
33+
34+
## Related Issues
35+
Are there any related issues or discussions? Please link them here.
36+
37+
---
38+
39+
**Note:** For general discussions or open-ended topics, consider starting a [GitHub Discussion](../../discussions) instead of opening an issue.

0 commit comments

Comments
 (0)