Skip to content

docs: Add contributing guide and improve community documentation#2162

Merged
dsp-ant merged 15 commits into
mainfrom
docs/contributing-to-protocol
Jan 30, 2026
Merged

docs: Add contributing guide and improve community documentation#2162
dsp-ant merged 15 commits into
mainfrom
docs/contributing-to-protocol

Conversation

@dsp-ant

@dsp-ant dsp-ant commented Jan 28, 2026

Copy link
Copy Markdown
Member

Summary

This PR adds a comprehensive contributing guide and improves the overall quality and usability of the community documentation.

Requesting review from @modelcontextprotocol/docs-maintainers

Changes

New Content

  • Contributing Guide (docs/community/contributing.mdx): A comprehensive guide for new contributors covering:
    • Prerequisites and environment setup
    • Repository structure explanation
    • Step-by-step first contribution guide
    • Types of contributions (small vs. major/SEP-required)
    • SDK contribution guidance
    • Getting help and finding sponsors
    • Troubleshooting common issues
    • AI contribution disclosure policy

Improved Formatting

  • Added tables throughout for better scannability
  • Added ASCII diagrams for governance hierarchy and SEP workflow
  • Better section organization with clearer heading hierarchy
  • Consistent terminology (Core Maintainers, Lead Maintainers capitalized)

Content Improvements

  • Antitrust policy: Added clarifying note that policy applies to group discussions, not day-to-day individual contributor work
  • SEP guidelines: Added prototype requirements section, dormant vs. rejected clarification, after-rejection guidance
  • Working/Interest Groups: Added "Quick Reference" comparison table, "When to Use Which" section, expanded FAQ
  • SEPs index: Simplified by removing redundant status definitions (now references SEP guidelines)

Navigation Updates

  • Added contributing page to community section sidebar
  • Updated all specification index pages to link to new contributing page
  • Updated redirect from /development/contributing to /community/contributing

Validation

  • npm run check:docs passes
  • All links validated
  • Formatting checked with Prettier

localden
localden previously approved these changes Jan 29, 2026

@jonathanhefner jonathanhefner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good! I really like the simplified language!

Comment thread docs/community/communication.mdx Outdated
Comment thread docs/community/communication.mdx Outdated
Comment thread docs/community/contributing.mdx Outdated
Comment thread docs/community/contributing.mdx Outdated
Comment thread docs/community/contributing.mdx Outdated
Comment thread docs/community/contributing.mdx Outdated
Comment thread docs/community/sep-guidelines.mdx Outdated
Comment thread docs/community/sep-guidelines.mdx
Comment thread docs/community/sep-guidelines.mdx Outdated
Comment thread docs/community/sep-guidelines.mdx Outdated
Comment thread docs/community/communication.mdx Outdated
dsp-ant and others added 2 commits January 29, 2026 15:08
- Add comprehensive contributing guide (docs/community/contributing.mdx)
  covering prerequisites, setup, types of contributions, and troubleshooting

- Improve formatting across community docs with tables and ASCII diagrams
  for better scannability

- Add clarifying note to antitrust policy about when it applies

- Enhance SEP guidelines with workflow diagram, status table, and
  prototype requirements section

- Add 'When to Use Which' section and FAQ to Working/Interest Groups

- Update navigation to include contributing page and fix links

- Remove redundant status definitions from SEP index (now references
  SEP guidelines)
🏠 Remote-Dev: homespace
localden and others added 11 commits January 29, 2026 15:08
🏠 Remote-Dev: homespace
🏠 Remote-Dev: homespace
🏠 Remote-Dev: homespace
🏠 Remote-Dev: homespace
🏠 Remote-Dev: homespace
🏠 Remote-Dev: homespace
🏠 Remote-Dev: homespace
🏠 Remote-Dev: homespace
🏠 Remote-Dev: homespace
- Direct feature requests to GitHub Discussions, not Issues
- Add Live calls row to communication channels table
- Rename SECURITY.md to Vulnerability reports in table
- Update Node.js version requirements to 24+
- Update npm version to 11.x
- Remove redundant table row about testing
- Add @example to @includecode JSDoc reference
- Add Mintlify components documentation link
- Point to MCP Registry instead of deprecated servers list
- Replace ASCII art with Mermaid diagram in SEP workflow
- Change bi-weekly to every two weeks for clarity
@dsp-ant dsp-ant requested a review from dsp January 30, 2026 11:48
@dsp-ant dsp-ant merged commit 6c4c6f1 into main Jan 30, 2026
7 checks passed
@dsp-ant dsp-ant deleted the docs/contributing-to-protocol branch January 30, 2026 11:53
shivankgoel pushed a commit to shivankgoel/modelcontextprotocol that referenced this pull request Feb 16, 2026
…elcontextprotocol#2162)

* docs: Add contributing guide and improve community documentation

- Add comprehensive contributing guide (docs/community/contributing.mdx)
  covering prerequisites, setup, types of contributions, and troubleshooting

- Improve formatting across community docs with tables and ASCII diagrams
  for better scannability

- Add clarifying note to antitrust policy about when it applies

- Enhance SEP guidelines with workflow diagram, status table, and
  prototype requirements section

- Add 'When to Use Which' section and FAQ to Working/Interest Groups

- Update navigation to include contributing page and fix links

- Remove redundant status definitions from SEP index (now references
  SEP guidelines)

* Update SEP generation

:house: Remote-Dev: homespace

* Guide update.

:house: Remote-Dev: homespace

* Add line length limits.

:house: Remote-Dev: homespace

* Prettier fix

:house: Remote-Dev: homespace

* Update communication guidance.

:house: Remote-Dev: homespace

* Fix broken code blocks.

:house: Remote-Dev: homespace

* Add short explainers.

:house: Remote-Dev: homespace

* Improve step explainers.

:house: Remote-Dev: homespace

* Update for brevity

:house: Remote-Dev: homespace

* Fix explainers

:house: Remote-Dev: homespace

* Prettier is no longer yelling at me and breaking code blocks.

:house: Remote-Dev: homespace

* Address PR review feedback from jonathanhefner

- Direct feature requests to GitHub Discussions, not Issues
- Add Live calls row to communication channels table
- Rename SECURITY.md to Vulnerability reports in table
- Update Node.js version requirements to 24+
- Update npm version to 11.x
- Remove redundant table row about testing
- Add @example to @includecode JSDoc reference
- Add Mintlify components documentation link
- Point to MCP Registry instead of deprecated servers list
- Replace ASCII art with Mermaid diagram in SEP workflow
- Change bi-weekly to every two weeks for clarity

* Add note about source access

:house: Remote-Dev: homespace

---------

Co-authored-by: Den Delimarsky <den@anthropic.com>
Co-authored-by: Den Delimarsky <53200638+localden@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants