CONTRIBUTION.md
December 26, 2020 ยท View on GitHub
To contribute and test your changes.
How to contribute
- Clone https://github.com/moaazsidat/react-native-qrcode-scanner
- Make changes
- Clone https://github.com/moaazsidat/react-native-qrcode-scanner-demo
- Test your changes by doing one of the following
- Linking your local version of
react-native-qrcode-scannertoreact-native-qrcode-scanner-demousingnpm link - Make changes to the local file
qrcodeScanner.js, and import it https://github.com/moaazsidat/react-native-qrcode-scanner-demo/blob/master/index.ios.js#L17-L18
- Linking your local version of
- Once tested, make a pull request against https://github.com/moaazsidat/react-native-qrcode-scanner
- Await review, and upon accepted review, merge to master.
Where can I find stuff to contribute?
Navigate to Issues and filter by good first issue or help wanted labels
- https://github.com/moaazsidat/react-native-qrcode-scanner/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
- https://github.com/moaazsidat/react-native-qrcode-scanner/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
Active contributor
This project is looking for active contributors, especially those well-versed with Android. If you're interested in becoming an active contributor with write access, create an issue titled 'Active contributor', and create a pull request to address a couple of issues. If it goes well, I'd be happy to give write access to merge PRs to master.
Formatting for commit messages for merge commits
Any merges to the master branch will publish a new version of the NPM package.
This is done using semantic-release, and therefore, merge commits must follow the default semantic-release commit message format in order for the CI to pick up changes and publish the correct version bump.