Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

fix(docs): completing the url so that the link is correct#6545

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
jacobmllr95 merged 1 commit intobootstrap-vue:devfromwillidert:dev
Apr 21, 2021
Merged

Conversation

@willidert
Copy link
Contributor

Describe the PR

Hi, I was trying to apply the library to a personal project when I noticed a small error in the documentation.The links in the part that indicate that the library can be imported into html were missing the protocol, which caused a little inconvenience having to enter them manually. I took the liberty of making the changes and submitting this PR, I apologize for not opening an issue first, I am still learning to collaborate with open source projects.

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix (fixes a boo-boo in the code) -fix(...), requires a patch version update
  • Feature (adds a new feature to BootstrapVue) -feat(...), requires a minor version update
  • Enhancement (augments an existing feature) -feat(...), requires a minor version update
  • ARIA accessibility (fixes or improves ARIA accessibility) -fix(...), requires a patch or minor version update
  • Documentation update (improves documentation or typo fixes) -chore(docs), requires a patch version update
  • Other (please describe)

Does this PR introduce a breaking change? (check one)

  • No
  • Yes (please describe since breaking changes require a minor version update)

The PR fulfills these requirements:

  • It's submitted to thedev branch,not themaster branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e.[...] (fixes #xxx[,#xxx]), where "xxx" is the issue number)
  • It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • The title should follow theConventional Commits naming convention (i.e.fix(alert): not alerting during SSR render,docs(badge): update pill examples,chore(docs): fix typo in README, etc.).This is very important, as theCHANGELOG is generated from these messages, and determines the next version type (patch or minor).

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates
  • Includes component package.json meta section updates (prop, slot and event changes/updates)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (required for new features and enhancements)
  • Existing test suites are passing
  • CodeCov for patch has met target (all changes/updates have been tested)
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

@vercel
Copy link

vercelbot commentedApr 11, 2021
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect:https://vercel.com/bootstrap-vue/bootstrap-vue/3TDUv57phC9H6iavxJVG8YcnUNNE
✅ Preview:https://bootstrap-vue-git-fork-willidert-dev-bootstrap-vue.vercel.app

@codesandbox-ci
Copy link

This pull request is automatically built and testable inCodeSandbox.

To see build info of the built libraries, clickhere or the icon next to each commit SHA.

Latest deployment of this branch, based on commitd134c20:

SandboxSource
BootstrapVue Starter ProjectConfiguration
BootstrapVue Nuxt.js Starter ProjectConfiguration

@codecov
Copy link

codecovbot commentedApr 11, 2021
edited
Loading

Codecov Report

Merging#6545 (d134c20) intodev (1d59417) willnot change coverage.
The diff coverage isn/a.

Impacted file tree graph

@@            Coverage Diff            @@##               dev     #6545   +/-   ##=========================================  Coverage   100.00%   100.00%           =========================================  Files          299       299             Lines        10153     10153             Branches      2521      2521           =========================================  Hits         10153     10153
FlagCoverage Δ
unittests100.00% <ø> (ø)

Flags with carried forward coverage won't be shown.Click here to find out more.


Continue to review full report at Codecov.

Legend -Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing data
Powered byCodecov. Last update1d59417...d134c20. Read thecomment docs.

@Hiws
Copy link
Member

The URLs in the docs are actually valid, and should work without having to type in the protocol.
These areprotocol-relative URLs, meaning if you load the page in HTTP then the assets will be requested over HTTP, and if you load the page in HTTPS then they'll be loaded over HTTPS.

https://www.paulirish.com/2010/the-protocol-relative-url/

However, as described in the above link. There might be security issues with this "technique". So perhaps it's worth changing the docs to present a better example for the users.

willidert reacted with thumbs up emoji

@HiwsHiws added PR: PatchRequires patch version bump Type: Docs labelsApr 12, 2021
@willidert
Copy link
ContributorAuthor

I did not know urls with relative protocol until this morning (I am from Brazil), after reading a little I found these links that reinforce the update in the documentation, if they think it is necessary. Thank you so much for responding so quickly.

Protocol Relative urlsare a anti-pattern andhere too. And as well noted in the quote toPaul Irish they represent asecurity risk.

Other libraries likeVue andBootstrap do not use a relative protocol when accessing cdn resources.

Hiws reacted with thumbs up emoji

@jacobmllr95jacobmllr95 self-requested a reviewApril 21, 2021 23:23
@jacobmllr95jacobmllr95 changed the titlefix: completing the url so that the link is correct.fix(docs): completing the url so that the link is correctApr 21, 2021
@jacobmllr95jacobmllr95 merged commitc9c85a9 intobootstrap-vue:devApr 21, 2021
@jacobmllr95
Copy link
Member

Thanks@willidert!

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@jacobmllr95jacobmllr95jacobmllr95 approved these changes

Assignees

No one assigned

Labels

PR: PatchRequires patch version bumpType: Docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@willidert@Hiws@jacobmllr95

[8]ページ先頭

©2009-2025 Movatter.jp