Skip to content
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

Merged
merged 7 commits into from
Jan 26, 2024
Merged

Updates on config, tests, and docs #24

merged 7 commits into from
Jan 26, 2024

Conversation

erikziyunchi
Copy link
Member

@erikziyunchi erikziyunchi commented Jan 10, 2024

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.

Copy link

@sourcery-ai sourcery-ai bot left a 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

examples/clients/cli/README.md Show resolved Hide resolved
crates/wasm/src/config.rs Show resolved Hide resolved
examples/clients/cli/README.md Show resolved Hide resolved
@erikziyunchi erikziyunchi self-assigned this Jan 10, 2024
@erikziyunchi erikziyunchi changed the title Minor updates on config & docs Updates on config, tests, and docs Jan 17, 2024
.github/workflows/rust.yml Outdated Show resolved Hide resolved
.github/workflows/rust.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@gaukas gaukas left a 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.

@erikziyunchi erikziyunchi merged commit ac13a7c into main Jan 26, 2024
1 check passed
@erikziyunchi erikziyunchi deleted the fixing-config branch January 26, 2024 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants