Skip to content

Commit d78f088

Browse files
mukul975mukul975
committed
Add GitHub configuration files and CI workflow
1 parent b1423cd commit d78f088

File tree

5 files changed

+190
-0
lines changed

5 files changed

+190
-0
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in the `postgres-mcp-server` project and our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others’ private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
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, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected].
40+
41+
All complaints will be reviewed and investigated promptly and fairly.
42+
43+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
44+
45+
## Enforcement Guidelines
46+
47+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct.
48+
49+
### 1. Correction
50+
51+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
52+
53+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
54+
55+
### 2. Warning
56+
57+
**Community Impact**: A violation through a single incident or series of actions.
58+
59+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
60+
61+
### 3. Temporary Ban
62+
63+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
64+
65+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
66+
67+
### 4. Permanent Ban
68+
69+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
70+
71+
**Consequence**: A permanent ban from any sort of public interaction within the community.
72+
73+
## Attribution
74+
75+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at
76+
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
77+
78+
Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).
79+
80+
[homepage]: https://www.contributor-covenant.org
81+

‎.github/FUNDING.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# These are supported funding model platforms
2+
3+
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
13+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Pull Request Template
2+
3+
Thank you for contributing to postgres-mcp-server!
4+
5+
Please complete the checklist below and provide any relevant information to help us review your pull request.
6+
7+
### Description
8+
9+
<!-- A concise description of your changes -->
10+
11+
### Motivation and Context
12+
13+
<!-- Why is this change required? What problem does it solve? -->
14+
15+
### Related Issue(s)
16+
17+
<!-- If this PR addresses an open issue, please list it below -->
18+
19+
Fixes #
20+
21+
### Type of Change
22+
23+
- [ ] Bug fix
24+
- [ ] New feature
25+
- [ ] Documentation update
26+
- [ ] Breaking change
27+
- [ ] Refactor/maintenance
28+
29+
### Checklist
30+
31+
- [ ] I have read the **CONTRIBUTING** guidelines.
32+
- [ ] I have added/updated tests where applicable.
33+
- [ ] I have verified that all new and existing tests pass.
34+
- [ ] I have added necessary documentation (if appropriate).
35+
- [ ] My changes follow the project's coding style and conventions.
36+
37+
### Screenshots (if applicable)
38+
39+
<!-- Add screenshots to help explain your changes -->
40+
41+
### Additional Notes
42+
43+
<!-- Any other information that reviewers should know -->

‎.github/SUPPORT.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Support Guide
2+
3+
Thanks for using postgres-mcp-server!
4+
5+
If you have questions or need help:
6+
7+
1. **Search Issues:** Check if your question has already been answered.
8+
2. **Open a Discussion:** Use GitHub Discussions for general questions.
9+
3. **Open an Issue:** If you found a bug or need a feature, open an issue. Please include:
10+
* Steps to reproduce
11+
* Expected behavior
12+
* Actual behavior
13+
* Environment details (OS, Python version, PostgreSQL version)
14+
4. **Security Issues:** Please do not open public issues for security vulnerabilities. Instead, follow the SECURITY.md guidelines.
15+
16+
## Resources
17+
18+
* Documentation: See README.md and Wiki (if available)
19+
* Contributing: See CONTRIBUTING.md
20+
* Code of Conduct: See CODE_OF_CONDUCT.md

‎.github/workflows/ci.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Lint and Test
2+
3+
on:
4+
pull_request:
5+
branches: [ "main" ]
6+
push:
7+
branches: [ "main" ]
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
- name: Set up Python
19+
uses: actions/setup-python@v4
20+
with:
21+
python-version: "3.11"
22+
- name: Install dependencies
23+
run: |
24+
python -m pip install --upgrade pip
25+
pip install -r requirements.txt
26+
- name: Run tests
27+
run: |
28+
pytest -q
29+
- name: Lint with flake8
30+
run: |
31+
pip install flake8
32+
flake8 .
33+

0 commit comments

Comments
 (0)