Update contributing docs

Author: GromNaN

CONTRIBUTING.md

@@ -36,6 +36,31 @@ Before submitting a pull request:
 - Check the codebase to ensure that your feature doesn't already exist.
 - Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
 
+## Run Tests
+
+The full test suite requires PHP cli with mongodb extension, a running MongoDB server and a running MySQL server.
+Duplicate the `phpunit.xml.dist` file to `phpunit.xml` and edit the environment variables to match your setup.
+
+```bash
+$ docker-compose up -d mongodb mysql
+$ docker-compose run tests
+```
+
+Docker can be slow to start. You can run the command `php vendor/bin/phpunit --testdox` locally or in a docker container.
+
+```bash
+$ docker-compose run -it tests bash
+# Inside the container
+$ composer install
+$ vendor/bin/phpunit --testdox
+```
+
+For fixing style issues, you can run the PHP Code Beautifier and Fixer:
+
+```bash
+$ php vendor/bin/phpcbf
+```
+
 ## Requirements
 
 If the project maintainer has any additional requirements, you will find them listed here.
@@ -44,7 +69,7 @@ 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 `README.md` and any other relevant documentation are kept up-to-date.
+- **Document any change in behaviour** - Make sure the documentations are kept up-to-date.
 
 - **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
 

Dockerfile

@@ -8,14 +8,12 @@ RUN apt-get update && \
     pecl install xdebug && docker-php-ext-enable xdebug && \
     docker-php-ext-install -j$(nproc) pdo_mysql zip
 
-COPY --from=composer:2.5.8 /usr/bin/composer /usr/local/bin/composer
+COPY --from=composer:2.6.2 /usr/bin/composer /usr/local/bin/composer
+
+ENV COMPOSER_ALLOW_SUPERUSER=1
 
 WORKDIR /code
 
 COPY ./ ./
 
-ENV COMPOSER_ALLOW_SUPERUSER=1
-
-RUN composer install
-
-CMD ["./vendor/bin/phpunit", "--testdox"]
+CMD ["bash", "-c", "composer install && ./vendor/bin/phpunit --testdox"]

README.md

@@ -16,16 +16,14 @@ It is compatible with Laravel 10.x. For older versions of Laravel, please refer
 - [Eloquent Models](docs/eloquent-models.md)
 - [Query Builder](docs/query-builder.md)
 - [Transactions](docs/transactions.md)
+- [User Authentication](docs/authentication.md)
 - [Queues](docs/queues.md)
 - [Upgrading](docs/upgrade.md)
 
 ## Reporting Issues
 
-Issues pertaining to the library should be reported in the
-[PHPLIB](https://jira.mongodb.org/secure/CreateIssue!default.jspa?project-field=PHPLIB)
-project in MongoDB's JIRA. Extension-related issues should be reported in the
-[PHPC](https://jira.mongodb.org/secure/CreateIssue!default.jspa?project-field=PHPC)
-project.
+Issues pertaining to the library should be reported as
+[GitHub Issue](https://github.com/mongodb/laravel-mongodb/issues/new/choose).
 
 For general questions and support requests, please use one of MongoDB's
 [Technical Support](https://mongodb.com/docs/manual/support/) channels.
@@ -39,6 +37,6 @@ project, please report it according to the instructions in
 ## Development
 
 Development is tracked in the
-[PHPLIB](https://jira.mongodb.org/projects/PHPORM/summary) project in MongoDB's
+[PHPORM](https://jira.mongodb.org/projects/PHPORM/summary) project in MongoDB's
 JIRA. Documentation for contributing to this project may be found in
 [CONTRIBUTING.md](CONTRIBUTING.md).

composer.json

@@ -55,13 +55,16 @@
         },
         "laravel": {
             "providers": [
-                "MongoDBServiceProvider",
-                "MongoDBQueueServiceProvider"
+                "MongoDB\\Laravel\\MongoDBServiceProvider",
+                "MongoDB\\Laravel\\MongoDBQueueServiceProvider"
             ]
         }
     },
     "minimum-stability": "dev",
     "config": {
+        "platform": {
+            "php": "8.1"
+        },
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true
         }