Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (30 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 2.41 KB

Contributing to MCP Security Analysis

Thank you for considering contributing to the MCP Security Analysis project! We welcome contributions from the community to improve and expand this security resource.

How Can I Contribute?

Reporting Bugs

If you find a bug in the analysis, documentation, or methodology, please report it by opening an issue on the GitHub repository. Please include:

  • A clear and descriptive title.
  • A detailed description of the bug, including steps to reproduce if applicable.
  • The relevant section(s) of the documentation or analysis.
  • Any potential impact or suggestions for correction.

Suggesting Enhancements

If you have ideas for improving the analysis, adding new sections, refining the methodology, or clarifying the documentation, please open an issue with the label "enhancement". Describe your suggestion clearly and explain the potential benefits.

Code Contributions (Pull Requests)

We welcome direct contributions to the documentation (e.g., fixing typos, clarifying text, adding examples) or related code (if applicable in the future).

  1. Fork the Repository: Create your own fork of the mcp-security-analysis repository.
  2. Create a Branch: Create a new branch in your fork for your changes (e.g., git checkout -b feature/your-feature-name or git checkout -b fix/issue-description).
  3. Make Changes: Make your desired changes to the documentation or code.
  4. Commit Changes: Commit your changes with clear and concise commit messages.
  5. Push Changes: Push your branch to your fork (git push origin feature/your-feature-name).
  6. Open a Pull Request (PR): Open a pull request from your branch to the main branch of the original mcp-security-analysis repository.
    • Provide a clear title and description for your PR, explaining the changes and linking to any relevant issues.
    • Ensure your PR addresses only one specific issue or feature.

Pull Request Process

  1. PRs will be reviewed by the maintainers.
  2. Feedback may be provided, requiring further changes.
  3. Once approved, the PR will be merged.

Style Guides

Please adhere to standard Markdown formatting for documentation changes. Ensure clarity, conciseness, and accuracy in your contributions.

Questions?

If you have questions about contributing, feel free to open an issue with the label "question".

We appreciate your help in making the MCP ecosystem more secure!