Skip to content

Commit 07d216f

Browse files
RDCIST-3750: inner sourcing docs
1 parent d78a835 commit 07d216f

File tree

2 files changed

+109
-2
lines changed

2 files changed

+109
-2
lines changed

docs/CODE_OF_CONDUCT.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Code of Conduct
2+
3+
## Our Commitment
4+
5+
The **mcp-python-sdk** repository is maintained by the **Data Fabric Clients Team** and welcomes contributions from across OutSystems. We're committed to fostering an open, collaborative, and respectful environment where everyone can contribute effectively to our shared mission of building exceptional software.
6+
7+
This Code of Conduct outlines our expectations for all contributors and participants in this inner source project.
8+
9+
## Our Standards
10+
11+
We encourage behaviors that contribute to a positive and productive environment:
12+
13+
### Positive Behaviors ✓
14+
15+
- **Be Respectful**: Treat all contributors with courtesy and professionalism, valuing diverse perspectives and experiences
16+
- **Communicate Constructively**: Provide thoughtful feedback, ask clarifying questions, and engage in discussions with a solutions-oriented mindset
17+
- **Collaborate Openly**: Share knowledge, offer help to fellow contributors, and work together towards common goals
18+
- **Stay Professional**: Maintain a high standard of professionalism in all interactions, whether in code reviews, issues, or discussions
19+
- **Accept Feedback Gracefully**: View feedback as an opportunity to improve and learn, recognizing that code reviews strengthen our collective output
20+
- **Give Credit**: Acknowledge the contributions and ideas of others appropriately
21+
22+
### Unacceptable Behaviors ✗
23+
24+
- Personal attacks, insults, or derogatory comments
25+
- Harassment of any kind, including unwelcome attention or inappropriate conduct
26+
- Publishing others' private information without explicit permission
27+
- Disruptive or trolling behavior in discussions, issues, or pull requests
28+
- Other conduct that would reasonably be considered inappropriate in a professional setting
29+
30+
## Contribution Guidelines
31+
32+
### Maintainer Authority
33+
34+
The **Data Fabric Clients Team** serves as the maintainer and owner of this repository. As such:
35+
36+
- **The Data Fabric Clients Team makes final decisions** on all contributions, including whether to accept, reject, or request modifications to pull requests
37+
- All architectural decisions, coding standards, and project direction are determined by the Data Fabric Clients Team
38+
- Contributors are expected to respect the team's decisions, even when they may differ from personal preferences
39+
- The Data Fabric Clients Team reserves the right to close or decline contributions that don't align with the project's goals, architecture, or quality standards
40+
41+
### Before Contributing
42+
43+
We encourage you to:
44+
45+
1. **Review existing documentation**: Familiarize yourself with the project's README, architecture, and contribution guidelines
46+
2. **Discuss significant changes**: For major features or architectural changes, open an issue or reach out to the Data Fabric Clients Team *before* investing significant effort
47+
3. **Follow coding standards**: Adhere to the established coding conventions, styles, and patterns used throughout the repository
48+
49+
### Pull Request Expectations
50+
51+
When submitting a pull request:
52+
53+
- Provide a clear description of the problem being solved and your approach
54+
- Include relevant tests and documentation
55+
- Ensure all CI/CD checks pass
56+
- Respond promptly and constructively to review feedback and questions
57+
- Understand that the Data Fabric Clients Team may request changes, suggest alternative approaches, or decline the contribution if it doesn't align with the project's needs
58+
59+
### Response Times
60+
61+
The Data Fabric Clients Team will make reasonable efforts to review contributions in a timely manner. However:
62+
63+
- Review times may vary based on team capacity, priorities, and the complexity of the contribution
64+
- Contributors should be patient and understand that the team has multiple responsibilities
65+
- If you haven't received feedback within a reasonable timeframe, a polite reminder is acceptable
66+
67+
## Scope
68+
69+
This Code of Conduct applies to all spaces related to this repository, including:
70+
71+
- GitHub repository (code, issues, pull requests, discussions)
72+
- Code reviews and comments
73+
- Related communication channels (Slack, email, meetings, Jira, Confluence)
74+
- Any other forums or spaces where project-related discussions occur
75+
76+
## Enforcement
77+
78+
### Reporting Issues
79+
80+
If you experience or witness behavior that violates this Code of Conduct:
81+
82+
1. Contact the **Data Fabric Clients Team** directly through appropriate OutSystems channels
83+
2. Provide as much detail as possible, including dates, links, and context
84+
3. Reports will be handled with discretion and confidentiality
85+
86+
### Consequences
87+
88+
The Data Fabric Clients Team will review all reports and may take action including:
89+
90+
- Warning the individual about inappropriate behavior
91+
- Temporary or permanent ban from contributing to the repository
92+
- Escalation to OutSystems management or HR as appropriate
93+
- Other actions deemed necessary to maintain a healthy project environment
94+
95+
The Data Fabric Clients Team reserves the right to remove, edit, or reject comments, commits, code, issues, and other contributions that violate this Code of Conduct.
96+
97+
## Questions and Clarifications
98+
99+
If you have questions about this Code of Conduct or need clarification on any aspect of contributing to this repository, please reach out to the Data Fabric Clients Team.
100+
101+
## Acknowledgment
102+
103+
By contributing to this repository, you acknowledge that you have read, understood, and agree to abide by this Code of Conduct, and you recognize the Data Fabric Clients Team's authority as the final decision-maker for all contributions.
104+
105+
---
106+
107+
**Thank you for contributing to mcp-python-sdk!** We appreciate your interest in making this project better and look forward to collaborating with you.

README.md renamed to docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1056,7 +1056,7 @@ For a complete example with separate Authorization Server and Resource Server im
10561056
- **Resource Server (RS)**: Your MCP server that validates tokens and serves protected resources
10571057
- **Client**: Discovers AS through RFC 9728, obtains tokens, and uses them with the MCP server
10581058

1059-
See [TokenVerifier](src/mcp/server/auth/provider.py) for more details on implementing token validation.
1059+
See [TokenVerifier](../src/mcp/server/auth/provider.py) for more details on implementing token validation.
10601060

10611061
### FastMCP Properties
10621062

@@ -2099,7 +2099,7 @@ _Full example: [examples/snippets/clients/pagination_client.py](https://github.c
20992099
- **Backward compatible** - clients that don't support pagination will still work (they'll just get the first page)
21002100
- **Flexible page sizes** - Each endpoint can define its own page size based on data characteristics
21012101

2102-
See the [simple-pagination example](examples/servers/simple-pagination) for a complete implementation.
2102+
See the [simple-pagination example](../examples/servers/simple-pagination) for a complete implementation.
21032103

21042104
### Writing MCP Clients
21052105

0 commit comments

Comments
 (0)