diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ef9ad2e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,8 @@ +# CHANGELOG +## [2.3.2-beta] - 21/3/2024 +### Added +- Monorepo support + + +## [2.3.1] - 21/3/2024 + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a427b2b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing to `watermelondb-expo-plugin` + +Thank you for your interest in contributing to `watermelondb-expo-plugin`! We appreciate your help in making our project better. + +## Getting Started + +To contribute to this project, follow these steps: + +1. **Fork** the repository by clicking on the "Fork" button at the top right corner of this page. This will create a copy of the repository in your GitHub account. + +2. **Clone** your forked repository to your local machine: + +3. **Make** update and changes to the codebase. + +## Create a Pull Request + +Submit a **Pull Request** to the `beta` branch of the original repository. + +* Ensure that your changes are made to the beta branch of your forked repository. +* Submit your pull request (PR) from the branch where you made your changes to the beta branch of the original repository. +* Provide a clear and descriptive title for your PR and include any relevant information about the changes you've made. + +## Code Review +Once your pull request is submitted, it will undergo review by project maintainers. We appreciate your patience during this process and welcome any feedback or suggestions for improvement. + +Thank you for your contributions! diff --git a/MAINTAINERS_GUIDE.md b/MAINTAINERS_GUIDE.md new file mode 100644 index 0000000..a4d923e --- /dev/null +++ b/MAINTAINERS_GUIDE.md @@ -0,0 +1,35 @@ +# MAINTAINER'S GUIDE + +## Gitflow + +* `main`: branch is used for production releases. +* `beta`: branch is used for beta testing. It is gathering all the code from bug fixes and new features. +* `chore/*`: documentation updates, and maintenance tasks. +* `feature/*`: new features. +* `fix/*`: bug fixes. + +## Versioning + +We use semantic versioning. + +### Beta versions + +Before we release a new version, we first release one or more series of `beta` versions. + +For example if the current production version is 1.0.1, and we want to move on with releasing 1.0.2, first we release 1.0.2-beta.1, 1.0.2-beta.2, etc. until we are confident that the new version is stable. + +To release a beta: +1. Update the CHANGELOG.md file with the latest beta version and release date of the version. +2. bump the version in `package.json>version` to something like `1.0.2-beta.1`. +3. Then release by running: `npm publish --tag beta`. + + +## Production releases + +When we are confident that the beta version is stable, we release a production version. + +1. In `beta` branch bump the version in `package.json>version` to the new version, e.g. `1.0.2`. +2. Update the CHANGELOG.md file with the new version and release date of the version. The changes that were previously in beta should be moved to the new version. +3. Create a PR and merge `beta` to `main`. +4. Then release by running: `npm publish`. +