From 6a7e145151a117a429e268c54fd7f09afd8f43b9 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Fri, 19 Apr 2024 07:31:29 -0300 Subject: [PATCH] Docs folder standardization and other fixes --- LICENSE.md | 8 ++++---- README.md | 18 ++++++++++++------ docs/guide/en/testing.md | 35 +++++++++++++++++++++++++++++++++++ docs/guide/pt-BR/testing.md | 35 +++++++++++++++++++++++++++++++++++ docs/internals.md | 33 ++++----------------------------- 5 files changed, 90 insertions(+), 39 deletions(-) create mode 100644 docs/guide/en/testing.md create mode 100644 docs/guide/pt-BR/testing.md diff --git a/LICENSE.md b/LICENSE.md index bc5674fe4..6a920d605 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,17 +1,17 @@ -Copyright © 2008 by Yii Software (https://www.yiiframework.com/) +Copyright © 2008 by Yii Software () All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - * Redistributions of source code must retain the above copyright +* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright +* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - * Neither the name of Yii Software nor the names of its +* Neither the name of Yii Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. diff --git a/README.md b/README.md index 42e056a48..6289396de 100644 --- a/README.md +++ b/README.md @@ -41,15 +41,21 @@ The package could be installed via composer: composer require yiisoft/db-mssql ``` -## Usage +## Documentation -To configure connection to MSSQL database check [Connecting MSSQL](https://github.com/yiisoft/db/blob/master/docs/en/connection/mssql.md). +- To configure connection to MSSQL database check [Connecting MSSQL](https://github.com/yiisoft/db/blob/master/docs/en/connection/mssql.md). +- [Check the documentation docs](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage. -[Check the documentation docs](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage. +Testing: -## Testing +- [English](docs/guide/en/testing.md) +- [Portuguese - Brazil](docs/guide/pt-BR/testing.md) +- More information can be found in the [Internals.](docs/internals.md) -[Check the documentation](/docs/en/testing.md) to learn about testing. +## Support + +If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. +You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). ## Support the project @@ -65,7 +71,7 @@ To configure connection to MSSQL database check [Connecting MSSQL](https://githu ## License -The MSSQL Server Extension for Yii 3 is free software. It is released under the terms of the BSD License. +The Yii Access is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information. Maintained by [Yii Software](https://www.yiiframework.com/). diff --git a/docs/guide/en/testing.md b/docs/guide/en/testing.md new file mode 100644 index 000000000..51b3b440e --- /dev/null +++ b/docs/guide/en/testing.md @@ -0,0 +1,35 @@ +# Testing + +## Github actions + +All our packages have github actions by default, so you can test your [contribution](https://github.com/yiisoft/db-mssql/blob/master/.github/CONTRIBUTING.md) in the cloud. + +> Note: We recommend pull requesting in draft mode until all tests pass. + +## Docker image + +For greater ease it is recommended to use docker containers, for this you can use the [docker-compose.yml](https://docs.docker.com/compose/compose-file/) file that is in the docs folder. + +1. [MSSQL 2022](../../../docker-compose.yml) + +For running the docker containers you can use the following command: + +```shell +docker compose up -d +``` + +## Unit testing + +The package is tested with [PHPUnit](https://phpunit.de/). + +The following steps are required to run the tests: + +1. Run the docker container for the dbms. +2. Install the dependencies of the project with composer. +3. Run the tests. + +```shell +vendor/bin/phpunit +``` + +- More information can be found in the [Internals.](../../internals.md) diff --git a/docs/guide/pt-BR/testing.md b/docs/guide/pt-BR/testing.md new file mode 100644 index 000000000..51b3b440e --- /dev/null +++ b/docs/guide/pt-BR/testing.md @@ -0,0 +1,35 @@ +# Testing + +## Github actions + +All our packages have github actions by default, so you can test your [contribution](https://github.com/yiisoft/db-mssql/blob/master/.github/CONTRIBUTING.md) in the cloud. + +> Note: We recommend pull requesting in draft mode until all tests pass. + +## Docker image + +For greater ease it is recommended to use docker containers, for this you can use the [docker-compose.yml](https://docs.docker.com/compose/compose-file/) file that is in the docs folder. + +1. [MSSQL 2022](../../../docker-compose.yml) + +For running the docker containers you can use the following command: + +```shell +docker compose up -d +``` + +## Unit testing + +The package is tested with [PHPUnit](https://phpunit.de/). + +The following steps are required to run the tests: + +1. Run the docker container for the dbms. +2. Install the dependencies of the project with composer. +3. Run the tests. + +```shell +vendor/bin/phpunit +``` + +- More information can be found in the [Internals.](../../internals.md) diff --git a/docs/internals.md b/docs/internals.md index b514e5ff8..8dc4049f0 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -1,35 +1,11 @@ # Internals -## Github actions - -All our packages have github actions by default, so you can test your [contribution](https://github.com/yiisoft/db-mssql/blob/master/.github/CONTRIBUTING.md) in the cloud. - -> Note: We recommend pull requesting in draft mode until all tests pass. - -## Docker image - -For greater ease it is recommended to use docker containers, for this you can use the [docker-compose.yml](https://docs.docker.com/compose/compose-file/) file that is in the docs folder. - -1. [MSSQL 2022](/docker-compose.yml) - -For running the docker containers you can use the following command: - -```dockerfile -docker compose up -d -``` - ## Unit testing -The package is tested with [PHPUnit](https://phpunit.de/). - -The following steps are required to run the tests: - -1. Run the docker container for the dbms. -2. Install the dependencies of the project with composer. -3. Run the tests. +The package is tested with [PHPUnit](https://phpunit.de/). To run tests: ```shell -vendor/bin/phpunit +./vendor/bin/phpunit ``` ## Mutation testing @@ -58,10 +34,9 @@ use either newest or any specific version of PHP: ./vendor/bin/rector ``` -## Dependencies +## Composer require checker -Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive -[Composer](https://getcomposer.org/) dependencies. +This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`. To run the checker, execute the following command: