|
| 1 | +# Contributing to React Native Bundle Visualizer |
| 2 | + |
| 3 | +Thank you for helping out with **react-native-bundle-visualizer**. We'd like to make contributions as |
| 4 | +pleasant as possible, so here's a small guide of how we see it. Happy to hear your feedback about anything, so please let us know. |
| 5 | + |
| 6 | +## Tests |
| 7 | + |
| 8 | +All tests are run on Github Actions on opening a pull request or pushing to main, but you should use them locally when making changes. |
| 9 | + |
| 10 | +- `yarn test`: Run tests for react native cli app and expo app. |
| 11 | +- `yarn test:rn`: Run tests only for react native cli app. |
| 12 | +- `yarn test:expo`: Run tests only for expo app. |
| 13 | + |
| 14 | +## Sending a pull request |
| 15 | + |
| 16 | +When you're sending a pull request: |
| 17 | + |
| 18 | +- If you want fix/add something, please open new/ find existing issue, so we can discuss it. |
| 19 | +- We prefer small pull requests focused on one change, as those are easier to test/ review. |
| 20 | +- Please make sure that all tests are passing on your local machine. |
| 21 | +- Follow the template when opening a PR. |
| 22 | + |
| 23 | +## Commits and versioning |
| 24 | + |
| 25 | +All PRs are squashed into `master` branch and wrapped up in a single commit, |
| 26 | +following [conventional commit message](https://www.conventionalcommits.org/en/v1.0.0-beta.3). |
| 27 | + |
| 28 | +Most notably prefixes you'll see: |
| 29 | + |
| 30 | +- **fix**: Bug fixes, triggers _patch_ release |
| 31 | +- **feat**: New feature implemented, triggers _minor_ |
| 32 | +- **chore**: Changes that are not affecting end user (CI config changes, |
| 33 | + scripts, ["grunt work"](https://stackoverflow.com/a/26944812/3510245)) |
| 34 | +- **docs**: Documentation changes. |
| 35 | +- **perf**: A code change that improves performance. |
| 36 | +- **refactor**: A code change that neither fixes a bug nor adds a feature. |
| 37 | +- **test**: Adding missing tests or correcting existing tests. |
| 38 | + |
| 39 | +## License |
| 40 | + |
| 41 | +By contributing to React Native Bundle Visualizer, you agree that your contributions |
| 42 | +will be licensed under the **MIT** license. |
0 commit comments