2
2
3
3
> 👍🎉 First off, thanks for taking the time to contribute! 🎉👍
4
4
5
- ## Playground & Issue Reports
5
+ ## Playground & Issue reports
6
6
7
- If you want to play with BootstrapVue components without any local setup just head to
8
- [ OnlinePlayground ] ( https://bootstrap-vue.js.org/play ) and you can interactively play and test
7
+ If you want to play with BootstrapVue components without any local setup just head to our
8
+ [ Online Playground ] ( https://bootstrap-vue.js.org/play ) and you can interactively play and test
9
9
components with a fresh Vue instance. If you want to keep your changes or make PRs reporting a
10
- component's misbehaviour you can save them in JSFiddle and provide that link in issues.
10
+ component's misbehaviour you can save them to _ CodePen_ , _ CodeSandbox_ or _ JSFiddle_ and provide
11
+ that link in issues.
11
12
12
13
## Setup
13
14
14
15
- Clone this repo (` git clone https://github.com/bootstrap-vue/bootstrap-vue --branch=dev ` )
15
- - Make sure you have node & yarn installed locally.
16
+ - Make sure you have ` node ` & ` yarn ` installed locally
16
17
- ` cd bootstrap-vue `
17
- - Run ` yarn install ` to get all dependencies installed.
18
+ - Run ` yarn install ` to get all dependencies installed
18
19
19
20
## Work on components
20
21
21
22
If you want to hack and improve components locally, you can follow these steps:
22
23
23
- - Run ` yarn docs-dev ` to run a local development server.
24
- - Head to ` http://localhost:3000/play ` .
25
- - Now you can locally make changes to components (they are located in the ` components ` directory).
26
- Changes will be applied with webpack hot-reloading without needing to reload the page.
27
- - Finally feel free to share your awesome hacks with others and opening a PR.
24
+ - Run ` yarn docs-dev ` to run a local development server
25
+ - Head to ` http://localhost:3000/play `
26
+ - Now you can locally make changes to components (they are located in the ` components ` directory)
27
+ Changes will be applied with webpack hot-reloading without needing to reload the page
28
+ - Finally feel free to share your awesome hacks with others and opening a PR
28
29
29
30
## Test inside your project
30
31
31
32
If you want to see your changes in your project instead of the playground:
32
33
33
- - Execute ` yarn link ` inside _ bootstrap-vue_ directory.
34
+ - Execute ` yarn link ` inside _ bootstrap-vue_ directory
34
35
- In your project run ` yarn link bootstrap-vue `
35
36
- Run ` yarn watch ` inside _ bootstrap-vue_
36
37
- Now every time you change a component, a new production version will be built and ready on your
37
- project.
38
+ project
38
39
39
40
## Pull requests
40
41
@@ -45,21 +46,21 @@ This is very important, as the `CHANGELOG` is generated from these messages.
45
46
Examples:
46
47
47
48
- ` fix(b-modal): fixes some broken modal stuff `
48
- - ` feat(b-table): add a feature to the table component! `
49
+ - ` feat(b-table): add a feature to the table component `
49
50
50
51
## Financial contributions
51
52
52
53
We also welcome financial contributions in full transparency on our
53
- [ open collective ] ( https://opencollective.com/bootstrap-vue ) . Anyone can file an expense. If the
54
+ [ Open Collective ] ( https://opencollective.com/bootstrap-vue ) . Anyone can file an expense. If the
54
55
expense makes sense for the development of the community, it will be "merged" in the ledger of our
55
56
open collective by the core contributors and the person who filed the expense will be reimbursed.
56
57
57
58
Consider asking your company to also support this open source project by
58
- [ becoming a sponsor] ( https://opencollective.com/bootstrap-vue#sponsor )
59
+ [ becoming a sponsor] ( https://opencollective.com/bootstrap-vue/contribute/ ) .
59
60
60
61
## Contributors
61
62
62
- Thank you to all the people who have already contributed to bootstrap-vue !
63
+ Thank you to all the people who have already contributed to BootstrapVue !
63
64
64
65
<div class =" p-3 mb-3text-center " >
65
66
<a href =" https://github.com/bootstrap-vue/bootstrap-vue/graphs/contributors " rel =" noopener " class =" d-inline-block " ><img src =" https://opencollective.com/bootstrap-vue/contributors.svg?width=890 " class =" img-fluid " ></a >
0 commit comments