Skip to content

Commit 25dacb5

Browse files
authored
feat: improve CONTRIBUTING.md (#4260)
1 parent 4421d44 commit 25dacb5

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,40 @@
22

33
> 👍🎉 First off, thanks for taking the time to contribute! 🎉👍
44
5-
## Playground & Issue Reports
5+
## Playground & Issue reports
66

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
99
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.
1112

1213
## Setup
1314

1415
- 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
1617
- `cd bootstrap-vue`
17-
- Run `yarn install` to get all dependencies installed.
18+
- Run `yarn install` to get all dependencies installed
1819

1920
## Work on components
2021

2122
If you want to hack and improve components locally, you can follow these steps:
2223

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
2829

2930
## Test inside your project
3031

3132
If you want to see your changes in your project instead of the playground:
3233

33-
- Execute `yarn link` inside _bootstrap-vue_ directory.
34+
- Execute `yarn link` inside _bootstrap-vue_ directory
3435
- In your project run `yarn link bootstrap-vue`
3536
- Run `yarn watch` inside _bootstrap-vue_
3637
- Now every time you change a component, a new production version will be built and ready on your
37-
project.
38+
project
3839

3940
## Pull requests
4041

@@ -45,21 +46,21 @@ This is very important, as the `CHANGELOG` is generated from these messages.
4546
Examples:
4647

4748
- `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`
4950

5051
## Financial contributions
5152

5253
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
5455
expense makes sense for the development of the community, it will be "merged" in the ledger of our
5556
open collective by the core contributors and the person who filed the expense will be reimbursed.
5657

5758
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/).
5960

6061
## Contributors
6162

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!
6364

6465
<div class="p-3 mb-3text-center">
6566
<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

Comments
 (0)