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

SUPPORT-638 : Update README.md #44

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

heyitsbryanm
Copy link

@heyitsbryanm heyitsbryanm commented Jul 7, 2023

Description

Some users were double encoding URLs prior to using the buildUrl function, resulting in double encoding.

Adds double encoding comment to README.

Note that a future solution could be to detect encoding -> prevent double encoding with the buildUrl feature (see this issue)

Checklist

  • Read the contributing guidelines.
  • Each commit follows the Conventional Commit spec format.
  • Update the readme (if applicable).
  • Update or add any necessary API documentation (if applicable)
  • All existing unit tests are still passing (if applicable).
  • Add some steps so we can test your bug fix or feature (if applicable).
  • Add new passing unit tests to cover the code introduced by your PR (if applicable).
  • Any breaking changes are specified on the commit on which they are introduced with BREAKING CHANGE in the body of the commit.
  • If this is a big feature with breaking changes, consider opening an issue to discuss first. This is completely up to you, but please keep in mind that your PR might not be accepted.

Adds double encoding comment to readme
@heyitsbryanm heyitsbryanm requested a review from a team as a code owner July 7, 2023 15:36
@commit-lint
Copy link

commit-lint bot commented Jul 7, 2023

Contributors

heyitsbryanm

Commit-Lint commands

You can trigger Commit-Lint actions by commenting on this PR:

  • @Commit-Lint merge patch will merge dependabot PR on "patch" versions (X.X.Y - Y change)
  • @Commit-Lint merge minor will merge dependabot PR on "minor" versions (X.Y.Y - Y change)
  • @Commit-Lint merge major will merge dependabot PR on "major" versions (Y.Y.Y - Y change)
  • @Commit-Lint merge disable will desactivate merge dependabot PR
  • @Commit-Lint review will approve dependabot PR
  • @Commit-Lint stop review will stop approve dependabot PR

@heyitsbryanm heyitsbryanm requested review from a team and removed request for a team July 25, 2023 20:59
@heyitsbryanm heyitsbryanm changed the title Update README.md SUPPORT-638 : Update README.md Jul 25, 2023
Copy link
Contributor

@luqven luqven left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚢

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