Skip to content

chore(docs): improve Bootstrap/BootstrapVue style import guide in "Getting started" docs #6222

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

Merged
merged 10 commits into from
Dec 19, 2020

Conversation

darrelfrancis
Copy link
Contributor

@darrelfrancis darrelfrancis commented Dec 16, 2020

The original version was a little confusing because it was repetitive and missed the opportunity to make clear at the outset that there are potentially 3 SCSS files and they must be imported in order.

Describe the PR

Simplify the documentation making clear the importance of the order, and exactly how to import

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 the dev branch, not the master 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 the Conventional 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 the CHANGELOG is generated from these messages, and determines the next version type (patch or minor).

The original version was a little confusing because it was repetitive and missed the opportunity to make clear at the outset that there are potentially 3 SCSS files and they must be imported in order.
@vercel
Copy link

vercel bot commented Dec 16, 2020

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/5dnaqe080
✅ Preview: https://bootstrap-vue-git-patch-6.bootstrap-vue.vercel.app

@codesandbox-ci
Copy link

codesandbox-ci bot commented Dec 16, 2020

This pull request is automatically built and testable in CodeSandbox.

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

Latest deployment of this branch, based on commit 9c2a971:

Sandbox Source
BootstrapVue Starter Project Configuration
BootstrapVue Nuxt.js Starter Project Configuration

@codecov
Copy link

codecov bot commented Dec 16, 2020

Codecov Report

Merging #6222 (9c2a971) into dev (206b388) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##               dev     #6222   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          299       299           
  Lines        10035     10035           
  Branches      2513      2513           
=========================================
  Hits         10035     10035           
Flag Coverage Δ
unittests 100.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 by Codecov. Last update 206b388...9c2a971. Read the comment docs.

@jacobmllr95 jacobmllr95 changed the title docs(readme.md) Improve explan of custom, Bootstrap & BoostrapVue scss chore(docs): improve Bootstrap/BootstrapVue style import guide in "Getting started" docs Dec 17, 2020
Sorry! Thank you for updating. I have further clarified.

Hopefully it is OK now?
@jacobmllr95
Copy link
Member

@darrelfrancis I made some final adjustments. Are you fine with that?

Copy link
Contributor Author

@darrelfrancis darrelfrancis left a comment

Choose a reason for hiding this comment

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

Looks great to me, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants