Skip to content

feat: improve CONTRIBUTING.md #4260

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.

Sign up for GitHub

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 1 commit into from
Oct 15, 2019
Merged

feat: improve CONTRIBUTING.md #4260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,40 @@

> 👍🎉 First off, thanks for taking the time to contribute! 🎉👍

## Playground & Issue Reports
## Playground & Issue reports

If you want to play with BootstrapVue components without any local setup just head to
[OnlinePlayground](https://bootstrap-vue.js.org/play) and you can interactively play and test
If you want to play with BootstrapVue components without any local setup just head to our
[Online Playground](https://bootstrap-vue.js.org/play) and you can interactively play and test
components with a fresh Vue instance. If you want to keep your changes or make PRs reporting a
component's misbehaviour you can save them in JSFiddle and provide that link in issues.
component's misbehaviour you can save them to _CodePen_, _CodeSandbox_ or _JSFiddle_ and provide
that link in issues.

## Setup

- Clone this repo (`git clone https://github.com/bootstrap-vue/bootstrap-vue --branch=dev`)
- Make sure you have node & yarn installed locally.
- Make sure you have `node` & `yarn` installed locally
- `cd bootstrap-vue`
- Run `yarn install` to get all dependencies installed.
- Run `yarn install` to get all dependencies installed

## Work on components

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

- Run `yarn docs-dev` to run a local development server.
- Head to `http://localhost:3000/play`.
- Now you can locally make changes to components (they are located in the `components` directory).
Changes will be applied with webpack hot-reloading without needing to reload the page.
- Finally feel free to share your awesome hacks with others and opening a PR.
- Run `yarn docs-dev` to run a local development server
- Head to `http://localhost:3000/play`
- Now you can locally make changes to components (they are located in the `components` directory)
Changes will be applied with webpack hot-reloading without needing to reload the page
- Finally feel free to share your awesome hacks with others and opening a PR

## Test inside your project

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

- Execute `yarn link` inside _bootstrap-vue_ directory.
- Execute `yarn link` inside _bootstrap-vue_ directory
- In your project run `yarn link bootstrap-vue`
- Run `yarn watch` inside _bootstrap-vue_
- Now every time you change a component, a new production version will be built and ready on your
project.
project

## Pull requests

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

- `fix(b-modal): fixes some broken modal stuff`
- `feat(b-table): add a feature to the table component!`
- `feat(b-table): add a feature to the table component`

## Financial contributions

We also welcome financial contributions in full transparency on our
[open collective](https://opencollective.com/bootstrap-vue). Anyone can file an expense. If the
[Open Collective](https://opencollective.com/bootstrap-vue). Anyone can file an expense. If the
expense makes sense for the development of the community, it will be "merged" in the ledger of our
open collective by the core contributors and the person who filed the expense will be reimbursed.

Consider asking your company to also support this open source project by
[becoming a sponsor](https://opencollective.com/bootstrap-vue#sponsor)
[becoming a sponsor](https://opencollective.com/bootstrap-vue/contribute/).

## Contributors

Thank you to all the people who have already contributed to bootstrap-vue!
Thank you to all the people who have already contributed to BootstrapVue!

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