Add comprehensive documentation for adding new services to MSMetaEnhancer #167
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.
This PR addresses issue #XX by adding detailed step-by-step instructions to the contributing documentation on how to add new services and conversion functions to MSMetaEnhancer.
What's Changed
The
CONTRIBUTING.mdfile has been significantly enhanced with comprehensive guidance for developers who want to extend MSMetaEnhancer with new conversion services. The documentation now includes:🏗️ Architecture Overview
Converter,WebConverter,ComputeConverter)🌐 Web Converter Development
Complete guide for adding external API services with:
__init__.pyExample structure for a new web service:
💻 Compute Converter Development
Instructions for local computation services including:
🔧 Extending Existing Services
Guidelines for adding new conversion functions to existing converters, including method naming conventions and registration patterns.
📋 Best Practices
Coverage of key development principles:
ThrottlerclassWhy This Matters
The modular architecture of MSMetaEnhancer makes it relatively straightforward to add new services, but until now there was no documentation explaining how to do it. This enhancement:
Validation
All changes have been validated by:
The documentation is based on analysis of the existing converters and follows the established patterns used by services like CTS, PubChem, IDSM, and RDKit.
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.