diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..c3aad8477 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,10 @@ + + +### Checklist + +- [ ] Add tests and ensure they pass +- [ ] Add an entry to the CHANGELOG.md file +- [ ] Update documentation for new features diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f897386a..27ab3d4d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,16 @@ # Changelog All notable changes to this project will be documented in this file. +## [4.0.3] - unreleased + + +## [4.0.2] - 2023-11-03 + +- Fix compatibility with Laravel 10.30 [#2661](https://github.com/mongodb/laravel-mongodb/pull/2661) by [@Treggats](https://github.com/Treggats) +- PHPORM-101 Allow empty insert batch for consistency with Eloquent SQL [#2661](https://github.com/mongodb/laravel-mongodb/pull/2645) by [@GromNaN](https://github.com/GromNaN) + +*4.0.1 skipped due to a mistake in the release process.* + ## [4.0.0] - 2023-09-28 - Rename package to `mongodb/laravel-mongodb` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4de5b27bd..a6e6a8f1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,8 @@ Before submitting a pull request: ## Run Tests -The full test suite requires PHP cli with mongodb extension, a running MongoDB server and a running MySQL server. +The full test suite requires PHP cli with mongodb extension and a running MongoDB server. A replica set is required for +testing transactions. Duplicate the `phpunit.xml.dist` file to `phpunit.xml` and edit the environment variables to match your setup. ```bash @@ -69,14 +70,13 @@ If the project maintainer has any additional requirements, you will find them li - **Add tests!** - Your patch won't be accepted if it doesn't have tests. -- **Document any change in behaviour** - Make sure the documentation is kept up-to-date. +- **Document any change in behaviour** - Make sure the documentation is kept up-to-date, and update the changelog for +new features and bug fixes. - **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option. - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. -- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. - Happy coding! ## Releasing