docs(CONTRIBUTING): add a section on server categorization #606
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds guidance for categorizing new MCP servers in the root README and adjusts the Code of Conduct email formatting.
- Introduces a “Special README.md considerations” section in CONTRIBUTING.md
- Updates the Code of Conduct contact line to use angle brackets for the email
Comments suppressed due to low confidence (3)
CONTRIBUTING.md:31
- [nitpick] Consider removing the "./" prefix in the code span so it consistently reads
README.md, matching other references in the docs.
### Special `./README.md` considerations for new MCP servers
CONTRIBUTING.md:33
- [nitpick] This line is very long; consider breaking it into multiple bullet points or wrapping at ~80 characters to improve readability.
When adding a new MCP server, you must update the README.md to include your server in the appropriate categories under "Browse by What You're Building" and "Browse by How You're Working" sections with a brief description that clearly explains its purpose. Include a link to the server's directory using the pattern `src/your-server-name/`. Ensure your server's description is consistent with the style of existing entries.
CONTRIBUTING.md:46
- Convert this to a Markdown mailto link for better usability, e.g.,
[opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com).
<opensource-codeofconduct@amazon.com> with any additional questions or comments.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #606 +/- ##
==========================================
- Coverage 86.47% 86.34% -0.13%
==========================================
Files 360 350 -10
Lines 23866 23317 -549
Branches 3762 3694 -68
==========================================
- Hits 20637 20132 -505
+ Misses 2137 2106 -31
+ Partials 1092 1079 -13 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com>
alexa-perlov
approved these changes
Jun 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a special consideration for server categorization in the root readme
Summary
Changes
User experience
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change? (Y/N)
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.