-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updates on config, tests, and docs #24
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR Type: Refactoring
PR Summary: The pull request includes updates to configuration structures and documentation. It removes the 'bypass' field from the Config struct and updates the corresponding documentation and example code to reflect this change. Additionally, the example configuration in the README has been updated with a new password and explanatory comments.
Decision: Comment
📝 Type: 'Refactoring' - not supported yet.
- Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
📝 Complexity: the changes are too large or complex for Sourcery to approve.
- Unsupported files: the diff contains files that Sourcery does not currently support during reviews.
General suggestions:
- Ensure that the removal of the 'bypass' field is clearly communicated in the documentation, including the rationale behind this change and any potential impact on existing configurations.
- Consider providing a clean example configuration in the documentation without instructions to remove comments, to avoid confusion for users who might copy the configuration as is.
- Avoid including potentially sensitive defaults in documentation examples. Use placeholders or clearly non-sensitive default values to prevent security risks.
Your trial expires on January 15, 2024. Please email [email protected] to continue using Sourcery ✨
Did you find the review useful? React with a 👍 or 👎 to each comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Thanks for making these changes.
Renamed the crate to be WATM(WebAssembly-based Transport Module), and some tests cleanup. As well as removed the bypass config flag from WATM examples except
shadowsocks.wasm
where they don't support such feature yet.