docs: add contributing guide #65
Merged
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
Contributor
ImBIOS
commented
May 22, 2025
ImBIOS
commented
- Created a comprehensive CONTRIBUTING.md file to guide new contributors on setup, development workflow, testing, and pull request processes.
- Included prerequisites, repository setup instructions, code style guidelines, and testing procedures.
- Documented the process for adding new features and writing tests to ensure consistency and quality in contributions.
- Updated README.md to include usage accounting use cases and examples. - Enhanced OpenRouterChatLanguageModel to support usage accounting settings and metadata extraction. - Implemented detailed usage information tracking in responses. - Added tests for usage accounting functionality, ensuring correct metadata inclusion based on settings. Tested: - Verified that usage accounting data is included in responses when enabled. - Confirmed that provider-specific metadata is omitted when usage accounting is disabled.
- Moved `OpenRouterSharedSettings` type definition to the correct location in `src/types.ts`. - Added `extraBody` property to `OpenRouterSharedSettings`. - Marked `includeReasoning` as deprecated, suggesting to use `reasoning` instead. Tested: - No functional changes, but type definitions are now correctly structured.
- Added support for OpenRouter usage accounting feature, enabling tracking of token usage details in API responses. - Updated schema to accommodate the new usage accounting response format. - Documented changes in CHANGELOG.md. Tested: - Verified that usage accounting data is correctly included in both streaming and non-streaming API responses.
- Created a comprehensive CONTRIBUTING.md file to guide new contributors on setup, development workflow, testing, and pull request processes. - Included prerequisites, repository setup instructions, code style guidelines, and testing procedures. - Documented the process for adding new features and writing tests to ensure consistency and quality in contributions.
|
Oh, I forgot to use main as the base branch, wait, lemme force push. |
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.