Thanks for taking the time and for your help in improving this project!
- RudderStack Contributor Agreement
- Contribute to this project
- Committing
- Conventional commit messages format for React-Native monorepo
- Installing and setting up RudderStack
- Getting help
To contribute to this project, we need you to sign the Contributor License Agreement (“CLA”) for the first commit you make. By agreeing to the CLA we can add you to list of approved contributors and review the changes proposed by you.
If you encounter a bug or have any suggestion for improving this project, you can submit an issue describing your proposed change. Alternatively, you can propose a change by making a pull request and tagging our team members.
For more information on the different ways in which you can contribute to RudderStack, you can chat with us on our Slack channel.
We prefer squash or rebase commits so that all changes from a branch are committed to master as a single commit. All pull requests are squashed when merged, but rebasing prior to merge gives you better control over the commit message.
To maintain consistency and provide clear information about the nature of commits, it is essential to follow conventional commit messages. The commit message format should adhere to <type>(scope): <description>, and you can find more details about it here. By following this format, you ensure that commit messages are structured and convey the necessary information effectively.
List of React-Native packages and their corresponding commit message format:
| React Native packages | Fix commit message format | Feature commit message format |
|---|---|---|
| rudder-sdk-react-native | fix(rudder-sdk-react-native): fix some issue | feat(rudder-sdk-react-native): add some new feature |
| rudder-integration-amplitude-react-native | fix(rudder-integration-amplitude-react-native): fix some issue | feat(rudder-integration-amplitude-react-native): add some new feature |
| rudder-integration-appcenter-react-native | fix(rudder-integration-appcenter-react-native): fix some issue | feat(rudder-integration-appcenter-react-native): add some new feature |
| rudder-integration-appsflyer-react-native | fix(rudder-integration-appsflyer-react-native): fix some issue | feat(rudder-integration-appsflyer-react-native): add some new feature |
| rudder-integration-braze-react-native | fix(rudder-integration-braze-react-native): fix some issue | feat(rudder-integration-braze-react-native): add some new feature |
| rudder-integration-clevertap-react-native | fix(rudder-integration-clevertap-react-native): fix some issue | feat(rudder-integration-clevertap-react-native): add some new feature |
| rudder-integration-facebook-react-native | fix(rudder-integration-facebook-react-native): fix some issue | feat(rudder-integration-facebook-react-native): add some new feature |
| rudder-integration-firebase-react-native | fix(rudder-integration-firebase-react-native): fix some issue | feat(rudder-integration-firebase-react-native): add some new feature |
| rudder-integration-moengage-react-native | fix(rudder-integration-moengage-react-native): fix some issue | feat(rudder-integration-moengage-react-native): add some new feature |
| rudder-integration-singular-react-native | fix(rudder-integration-singular-react-native): fix some issue | feat(rudder-integration-singular-react-native): add some new feature |
| example | fix(example): fix some issue | feat(example): add some new feature |
| rudder-sdk-react-native-monorepo | fix(rudder-sdk-react-native-monorepo): fix some issue | feat(rudder-sdk-react-native-monorepo): add some new feature |
| rudder-plugin-db-encryption-react-native | fix(rudder-plugin-db-encryption-react-native): fix some issue | feat(rudder-plugin-db-encryption-react-native): add some new feature |
You may also use chore and other commit types as described in the Conventional Commit documentation. But only fix and feat commits will be considered for changelog generation.
To contribute to this project, you may need to install RudderStack on your machine. You can do so by following our docs and set up RudderStack in no time.
For any questions, concerns, or queries, you can start by asking a question on our Slack channel.