[Refactor] Improve Structure and Clarity of CONTRIBUTING.md #1084
Conversation
This file contains 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
…on guidelines - refactored the `CONTRIBUTING.md` guide for better clarity and organization - added a table of contents to enhance navigation - cleaned up unused imports in the `language_client_codegen` folder
|
@miguelcsx is attempting to deploy a commit to the Gloo Team on Vercel. A member of the Team first needs to authorize it. |
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to 9bb9cb6 in 20 seconds
More details
- Looked at
361lines of code in6files - Skipped
0files when reviewing. - Skipped posting
4drafted comments based on config settings.
1. engine/language_client_codegen/src/openapi.rs:4
- Draft comment:
LiteralValueis imported but not used in this file. Consider removing it to clean up the code. - Reason this comment was not posted:
Confidence changes required:50%
The PR description mentions removing unused imports, and I noticed that theLiteralValueimport is no longer used inopenapi.rs. This should be removed to maintain code cleanliness.
2. engine/language_client_codegen/src/ruby/generate_types.rs:3
- Draft comment:
use std::collections::HashSet;is no longer used in this file. Consider removing it to clean up the code. - Reason this comment was not posted:
Confidence changes required:50%
The PR description mentions removing unused imports, and I noticed that theHashSetimport is no longer used ingenerate_types.rs. This should be removed to maintain code cleanliness.
3. engine/language_client_codegen/src/ruby/mod.rs:9
- Draft comment:
use either::Either;is no longer used in this file. Consider removing it to clean up the code. - Reason this comment was not posted:
Confidence changes required:50%
The PR description mentions removing unused imports, and I noticed that theEitherimport is no longer used inmod.rs. This should be removed to maintain code cleanliness.
4. engine/language_client_codegen/src/typescript/mod.rs:7
- Draft comment:
use either::Either;is no longer used in this file. Consider removing it to clean up the code. - Reason this comment was not posted:
Confidence changes required:50%
The PR description mentions removing unused imports, and I noticed that theEitherimport is no longer used inmod.rs. This should be removed to maintain code cleanliness.
Workflow ID: wflow_sxPOUqWRyrq3mNMP
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
hellovai
reviewed
Oct 22, 2024
| @@ -30,7 +29,7 @@ pub(crate) struct RubyStreamTypes<'ir> { | |||
| partial_classes: Vec<PartialRubyStruct<'ir>>, | |||
| } | |||
|
|
|||
| /// The Python class corresponding to Partial<TypeDefinedInBaml> | |||
| /// The Python class corresponding to Partial<TypeDefinedjInBaml> | |||
There was a problem hiding this comment.
@hellovai in the next PR, I will correct it, my bad
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.
Description
This PR implements the following changes:
CONTRIBUTING.md: The contributing guidelines have been restructured for better clarity and organization. A table of contents has also been added for easier navigation.language_client_codegenfolder to enhance code quality.Key Changes
Refactored the content and structure of
CONTRIBUTING.md.Added a table of contents to improve usability.
Removed unnecessary imports from
language_client_codegen.No breaking changes were introduced, ensuring that contributors can easily follow the updated guidelines.
Closes Issue: #1083
Important
Refactor
CONTRIBUTING.mdfor clarity and remove unused imports inlanguage_client_codegen.CONTRIBUTING.mdfor better clarity and organization.CONTRIBUTING.mdfor easier navigation.language_client_codegen/src/openapi.rs,language_client_codegen/src/ruby/field_type.rs, andlanguage_client_codegen/src/ruby/mod.rs.This description was created by
for 9bb9cb6. It will automatically update as commits are pushed.