Skip to content

Commit 067411b

Browse files
neverinfamousneverinfamous
committed
Add comprehensive issue templates and PR template to meet GitHub community standards
- Add bug report template with detailed environment and reproduction fields - Add feature request template with categorization and priority - Add security vulnerability template with responsible disclosure guidelines - Add documentation improvement template for wiki and README updates - Add issue template config with contact links to discussions, wiki, and PyPI - Add comprehensive PR template with testing, security, and compatibility checklists Resolves GitHub community standards requirements for issue templates and PR template.
1 parent 87cc46c commit 067411b

File tree

6 files changed

+692
-0
lines changed

6 files changed

+692
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior in postgres-mcp-server
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out this form to help us understand and fix the issue.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Describe the bug...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Detailed steps to reproduce the behavior.
25+
placeholder: |
26+
1. Configure MCP server with...
27+
2. Execute tool...
28+
3. See error...
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What you expected to happen.
37+
placeholder: Describe what should happen...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: actual
43+
attributes:
44+
label: Actual Behavior
45+
description: What actually happened. Include error messages and logs.
46+
placeholder: Paste error messages or describe what happened...
47+
render: shell
48+
validations:
49+
required: true
50+
51+
- type: dropdown
52+
id: version
53+
attributes:
54+
label: Version
55+
description: Which version of postgres-mcp-server are you using?
56+
options:
57+
- "1.0.5 (latest)"
58+
- "1.0.4"
59+
- "1.0.3"
60+
- "1.0.2"
61+
- "1.0.1"
62+
- "1.0.0"
63+
- "Other (specify in additional context)"
64+
validations:
65+
required: true
66+
67+
- type: dropdown
68+
id: installation
69+
attributes:
70+
label: Installation Method
71+
description: How did you install postgres-mcp-server?
72+
options:
73+
- "Docker (recommended)"
74+
- "pip install"
75+
- "From source (uv)"
76+
- "From source (pip)"
77+
validations:
78+
required: true
79+
80+
- type: input
81+
id: postgres-version
82+
attributes:
83+
label: PostgreSQL Version
84+
description: What version of PostgreSQL are you using?
85+
placeholder: "e.g., 16.2, 15.4, 14.10"
86+
validations:
87+
required: true
88+
89+
- type: dropdown
90+
id: access-mode
91+
attributes:
92+
label: Access Mode
93+
description: Which access mode are you running in?
94+
options:
95+
- "restricted (production)"
96+
- "unrestricted (development)"
97+
validations:
98+
required: true
99+
100+
- type: dropdown
101+
id: mcp-client
102+
attributes:
103+
label: MCP Client
104+
description: Which MCP client are you using?
105+
options:
106+
- "Claude Desktop"
107+
- "Cursor IDE"
108+
- "Other (specify in additional context)"
109+
validations:
110+
required: true
111+
112+
- type: dropdown
113+
id: os
114+
attributes:
115+
label: Operating System
116+
description: What operating system are you running on?
117+
options:
118+
- "Linux"
119+
- "macOS"
120+
- "Windows"
121+
- "Docker"
122+
validations:
123+
required: true
124+
125+
- type: textarea
126+
id: extensions
127+
attributes:
128+
label: PostgreSQL Extensions
129+
description: Which PostgreSQL extensions do you have installed and enabled?
130+
placeholder: |
131+
- pg_stat_statements
132+
- hypopg
133+
- pgvector
134+
- PostGIS
135+
render: markdown
136+
137+
- type: textarea
138+
id: logs
139+
attributes:
140+
label: Relevant Logs
141+
description: Please copy and paste any relevant log output.
142+
render: shell
143+
144+
- type: textarea
145+
id: context
146+
attributes:
147+
label: Additional Context
148+
description: Add any other context about the problem here (screenshots, configuration files, etc.).
149+
150+
- type: checkboxes
151+
id: terms
152+
attributes:
153+
label: Checklist
154+
description: Please confirm the following
155+
options:
156+
- label: I have searched existing issues to ensure this bug hasn't been reported
157+
required: true
158+
- label: I have read the [troubleshooting guide](https://github.com/neverinfamous/postgres-mcp/wiki/Troubleshooting)
159+
required: true
160+
- label: This is a bug in postgres-mcp-server, not in PostgreSQL itself
161+
required: true
162+
- label: I am NOT reporting a security vulnerability (use [security policy](https://github.com/neverinfamous/postgres-mcp/security/policy) instead)
163+
required: true
164+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 GitHub Discussions
4+
url: https://github.com/neverinfamous/postgres-mcp/discussions
5+
about: Ask questions, share ideas, or discuss postgres-mcp-server with the community
6+
- name: 📖 Documentation Wiki
7+
url: https://github.com/neverinfamous/postgres-mcp/wiki
8+
about: Browse comprehensive documentation, guides, and examples
9+
- name: 🔒 Security Policy
10+
url: https://github.com/neverinfamous/postgres-mcp/security/policy
11+
about: Learn how to responsibly report security vulnerabilities
12+
- name: 🐳 Docker Hub
13+
url: https://hub.docker.com/r/neverinfamous/postgres-mcp
14+
about: Get the official Docker images for postgres-mcp-server
15+
- name: 📦 PyPI Package
16+
url: https://pypi.org/project/postgres-mcp-enhanced/
17+
about: Install postgres-mcp-server from the Python Package Index
18+

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
name: 📚 Documentation Improvement
2+
description: Suggest improvements or report issues with documentation
3+
title: "[Docs]: "
4+
labels: ["documentation", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping us improve our documentation! Clear docs make postgres-mcp-server better for everyone.
10+
11+
- type: dropdown
12+
id: doc-type
13+
attributes:
14+
label: Documentation Type
15+
description: What type of documentation needs improvement?
16+
options:
17+
- "Wiki Page"
18+
- "README.md"
19+
- "Tool/API Documentation"
20+
- "Installation Guide"
21+
- "Configuration Guide"
22+
- "Troubleshooting Guide"
23+
- "Security Documentation"
24+
- "Contributing Guide"
25+
- "Code Comments"
26+
- "Examples/Tutorials"
27+
- "Other"
28+
validations:
29+
required: true
30+
31+
- type: input
32+
id: location
33+
attributes:
34+
label: Documentation Location
35+
description: Provide a link or path to the documentation that needs improvement
36+
placeholder: "https://github.com/neverinfamous/postgres-mcp/wiki/..."
37+
validations:
38+
required: true
39+
40+
- type: dropdown
41+
id: issue-type
42+
attributes:
43+
label: Issue Type
44+
description: What kind of documentation issue is this?
45+
options:
46+
- "Missing Information"
47+
- "Incorrect/Outdated Information"
48+
- "Unclear Explanation"
49+
- "Broken Link"
50+
- "Typo/Grammar"
51+
- "Missing Example"
52+
- "Technical Error"
53+
- "Needs Update for New Version"
54+
- "Other"
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: problem
60+
attributes:
61+
label: Current Problem
62+
description: What's wrong with the current documentation?
63+
placeholder: The current documentation states... but it should...
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: improvement
69+
attributes:
70+
label: Suggested Improvement
71+
description: How should the documentation be improved?
72+
placeholder: |
73+
I suggest updating it to say...
74+
Or adding a section about...
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
id: example
80+
attributes:
81+
label: Proposed Content (Optional)
82+
description: If you'd like, provide the exact text/content you think should be used
83+
placeholder: |
84+
Suggested text:
85+
```
86+
Your proposed content here
87+
```
88+
render: markdown
89+
90+
- type: dropdown
91+
id: audience
92+
attributes:
93+
label: Target Audience
94+
description: Who would benefit most from this improvement?
95+
options:
96+
- "New Users/Beginners"
97+
- "Experienced Users"
98+
- "Contributors/Developers"
99+
- "Database Administrators"
100+
- "Security Professionals"
101+
- "All Users"
102+
validations:
103+
required: true
104+
105+
- type: textarea
106+
id: context
107+
attributes:
108+
label: Additional Context
109+
description: Any other information that would help us improve the documentation
110+
111+
- type: checkboxes
112+
id: contribution
113+
attributes:
114+
label: Contribution
115+
options:
116+
- label: I have searched existing issues to avoid duplicates
117+
required: true
118+
- label: I have checked the [latest wiki version](https://github.com/neverinfamous/postgres-mcp/wiki)
119+
required: true
120+
- label: I would be willing to submit a PR to fix this documentation issue
121+
required: false
122+

0 commit comments

Comments
 (0)