| 1 | # Contributing
|
| 2 |
|
| 3 | Found a bug? Want a new feature? Don't like the docs? Please send a pull request or raise an issue.
|
| 4 |
|
| 5 | ## Raising issues
|
| 6 |
|
| 7 | When raising an issue, please add as much details as possible. Screenshots, video recordings, or anything else that can make it easier to reproduce the bug you are reporting.
|
| 8 |
|
| 9 | - A new option is to create a code pen with the code that causes the bug. Fork this [example](https://www.webpackbin.com/bins/-Kxr6IEf5zXSQvGCgKBR) and add your code there, then fork and add the new link to the issue.
|
| 10 |
|
| 11 | ## Creating Pull Requests
|
| 12 |
|
| 13 | Pull requests are always welcome. To speed up the review process, please ensure that your pull request have:
|
| 14 |
|
| 15 | - A good title and description message;
|
| 16 | - Recommended that each commit follows the commit message format #{issueId}: {commitDescriptionj}
|
| 17 | - Tests covering the changes;
|
| 18 | - Story (storybook) if it's a new feature;
|
| 19 | - Green builds;
|
| 20 |
|
| 21 | In order to send a Pull Request, you will need to setup your environment - check instructions below;
|
| 22 |
|
| 23 | ## How to setup the development environment
|
| 24 |
|
| 25 | Fork and clone the repo:
|
| 26 |
|
| 27 | - `git clone git@github.com:leandrowd/react-responsive-carousel.git`
|
| 28 |
|
| 29 | Ensure you have the right node version:
|
| 30 |
|
| 31 | - `nvm use` # or `nvm install` in case the right version is not installed. Find the right version looking at the `.nvmrc` file.
|
| 32 |
|
| 33 | Install dependencies:
|
| 34 |
|
| 35 | - `yarn install`
|
| 36 |
|
| 37 | Start the dev server:
|
| 38 |
|
| 39 | - `yarn start` and open the browser on `http://localhost:1234/index.html`
|
| 40 |
|
| 41 | Run the tests:
|
| 42 |
|
| 43 | - `yarn test`
|
| 44 |
|
| 45 | Format the files:
|
| 46 |
|
| 47 | - `yarn format:write` # this will also run as part of the pre-commit hook. CI will fail the build if unformatted files are pushed.
|
| 48 |
|
| 49 | Develop on storybooks (optional):
|
| 50 |
|
| 51 | - `yarn storybook`
|