Add Contributing Guidelines and Code of Conduct
Signed-off-by: Dariusz Jędrzejczyk <dariusz.jedrzejczyk@broadcom.com>
This commit is contained in:
parent
2e13f9f9df
commit
1adfa8a047
4 changed files with 233 additions and 5 deletions
119
CODE_OF_CONDUCT.md
Normal file
119
CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,119 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in 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, religion, or sexual identity and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming, diverse,
|
||||
inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our community
|
||||
include:
|
||||
|
||||
- Demonstrating empathy and kindness toward other people
|
||||
- Being respectful of differing opinions, viewpoints, and experiences
|
||||
- Giving and gracefully accepting constructive feedback
|
||||
- Accepting responsibility and apologizing to those affected by our mistakes, and
|
||||
learning from the experience
|
||||
- Focusing on what is best not just for us as individuals, but for the overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
- The use of sexualized language or imagery, and sexual attention or advances of any kind
|
||||
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or email address, without
|
||||
their explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a professional
|
||||
setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
## Scope
|
||||
|
||||
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.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to
|
||||
the community leaders responsible for enforcement at mcp-coc@anthropic.com. All
|
||||
complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the reporter
|
||||
of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining the
|
||||
consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**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.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series of actions.
|
||||
|
||||
**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.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including sustained
|
||||
inappropriate behavior.
|
||||
|
||||
**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.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**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.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within the
|
||||
community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
|
||||
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by
|
||||
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
91
CONTRIBUTING.md
Normal file
91
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
# Contributing to Model Context Protocol Java SDK
|
||||
|
||||
Thank you for your interest in contributing to the Model Context Protocol Java SDK!
|
||||
This document outlines how to contribute to this project.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
The following software is required to work on the codebase:
|
||||
|
||||
- `Java 17` or above
|
||||
- `Docker`
|
||||
- `npx`
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Fork the repository
|
||||
2. Clone your fork:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/YOUR-USERNAME/java-sdk.git
|
||||
cd java-sdk
|
||||
```
|
||||
|
||||
3. Build from source:
|
||||
|
||||
```bash
|
||||
./mvnw clean install -DskipTests # skip the tests
|
||||
./mvnw test # run tests
|
||||
```
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
Please create an issue in the repository if you discover a bug or would like to
|
||||
propose an enhancement. Bug reports should have a reproducer in the form of a code
|
||||
sample or a repository attached that the maintainers or contributors can work with to
|
||||
address the problem.
|
||||
|
||||
## Making Changes
|
||||
|
||||
1. Create a new branch:
|
||||
|
||||
```bash
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
|
||||
2. Make your changes
|
||||
3. Validate your changes:
|
||||
|
||||
```bash
|
||||
./mvnw clean test
|
||||
```
|
||||
|
||||
### Change Proposal Guidelines
|
||||
|
||||
#### Principles of MCP
|
||||
|
||||
1. **Simple + Minimal**: It is much easier to add things to the codebase than it is to
|
||||
remove them. To maintain simplicity, we keep a high bar for adding new concepts and
|
||||
primitives as each addition requires maintenance and compatibility consideration.
|
||||
2. **Concrete**: Code changes need to be based on specific usage and implementation
|
||||
challenges and not on speculative ideas. Most importantly, the SDK is meant to
|
||||
implement the MCP specification.
|
||||
|
||||
## Submitting Changes
|
||||
|
||||
1. For non-trivial changes, please clarify with the maintainers in an issue whether
|
||||
you can contribute the change and the desired scope of the change.
|
||||
2. For trivial changes (for example a couple of lines or documentation changes) there
|
||||
is no need to open an issue first.
|
||||
3. Push your changes to your fork.
|
||||
4. Submit a pull request to the main repository.
|
||||
5. Follow the pull request template.
|
||||
6. Wait for review.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
This project follows a Code of Conduct. Please review it in
|
||||
[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
|
||||
|
||||
## Questions
|
||||
|
||||
If you have questions, please create a discussion in the repository.
|
||||
|
||||
## License
|
||||
|
||||
By contributing, you agree that your contributions will be licensed under the MIT
|
||||
License.
|
||||
|
||||
## Security
|
||||
|
||||
Please review our [Security Policy](SECURITY.md) for reporting security issues.
|
||||
|
|
@ -30,11 +30,8 @@ To run the tests you have to pre-install `Docker` and `npx`.
|
|||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please:
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch
|
||||
3. Submit a Pull Request
|
||||
Contributions are welcome!
|
||||
Please follow the [Contributing Guidelines](CONTRIBUTING.md).
|
||||
|
||||
## Team
|
||||
|
||||
|
|
|
|||
21
SECURITY.md
Normal file
21
SECURITY.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# Security Policy
|
||||
|
||||
Thank you for helping us keep the SDKs and systems they interact with secure.
|
||||
|
||||
## Reporting Security Issues
|
||||
|
||||
This SDK is maintained by [Anthropic](https://www.anthropic.com/) as part of the Model
|
||||
Context Protocol project.
|
||||
|
||||
The security of our systems and user data is Anthropic’s top priority. We appreciate the
|
||||
work of security researchers acting in good faith in identifying and reporting potential
|
||||
vulnerabilities.
|
||||
|
||||
Our security program is managed on HackerOne and we ask that any validated vulnerability
|
||||
in this functionality be reported through their
|
||||
[submission form](https://hackerone.com/anthropic-vdp/reports/new?type=team&report_type=vulnerability).
|
||||
|
||||
## Vulnerability Disclosure Program
|
||||
|
||||
Our Vulnerability Program Guidelines are defined on our
|
||||
[HackerOne program page](https://hackerone.com/anthropic-vdp).
|
||||
Loading…
Reference in a new issue