Skip to content

Commit 1cfe56e

Browse files
committed
chore: added contribution.md
1 parent 07419a6 commit 1cfe56e

File tree

2 files changed

+44
-4
lines changed

2 files changed

+44
-4
lines changed

CONTRIBUTION.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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.

package.json

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@
3030
},
3131
"scripts": {
3232
"test": "yarn test:rn && yarn test:expo",
33-
"test:rn": "yarn test:rn:64",
34-
"test:rn:64": "cd test/RN64 && yarn install && npx ../.. && cd ../..",
35-
"test:expo": "yarn test:expo:42",
36-
"test:expo:42": "cd test/Expo42 && yarn install && npx ../.. && cd ../.."
33+
"test:rn": "cd test/RN64 && yarn install && npx ../.. && cd ../..",
34+
"test:expo": "cd test/Expo42 && yarn install && npx ../.. && cd ../.."
3735
}
3836
}

0 commit comments

Comments
 (0)