Thank you for helping out with react-native-svg! We'd like to make contributions as 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.
- Fork this repository
- Clone your fork
- Make a branch for your feature or bug fix (i.e.
git checkout -b added-getfoobar) - Work your magic
- Execute
yarn linkwhen done.
Add test example in TestsExample concerning your change following the convention of TestX.tsx where X is your PR number.
We use typescript for type checks, eslint with prettier for linting/formatting. All tests are run by github actions for all opened pull requests.
yarn test: Run all tests, except for e2e (see note below).yarn lint: Runeslintcheck.yarn tsc: Runtypescriptcheck.yarn jest: Runjesttype check.
Currently e2e tests exist here: https://github.com/msand/react-native-svg-e2e/
When you're sending a pull request:
- Communication is a key. If you want fix/add something, please consider either opening a new issue or finding an existing one so we can further discuss it.
- We prefer small pull requests focused on one change, as those are easier to test/check.
- Please make sure that all tests are passing on your local machine.
- Follow the template when opening a PR.
All PRs are merged into the main branch and released with release-it.
Most notably prefixes you'll see:
- fix: Bug fixes
- feat: New feature implemented
- chore: Changes that are not affecting end user (CI config changes, scripts, "grunt work")
- docs: Documentation changes.
- perf: A code change that improves performance.
- refactor: A code change that neither fixes a bug nor adds a feature.
- test: Adding missing tests or correcting existing tests.
We use release-it to release new versions of library from main branch.
You can report issues on our bug tracker. Please search for existing issues and follow the issue template when opening one.
By contributing to React Native Svg, you agree that your contributions will be licensed under the MIT license.