Docs folder standardization and other fixes (#177)

LICENSE.md

@@ -1,17 +1,17 @@
-Copyright © 2008 by Yii Software (https://www.yiiframework.com/)
+Copyright © 2008 by Yii Software (<https://www.yiiframework.com/>)
 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.
 

README.md

@@ -105,11 +105,10 @@ each package `composer.json`:
 In the above example the mapping keys are config group names and the values are configuration files and references to other config groups.
 The file paths are relative to the [source-directory](#source-directory), which by default is the path where `composer.json` is located.
 
-
-### Markers 
+### Markers
 
 - `?` - marks optional files. Absence of files not marked with this marker will cause exception.
-    ```
+    ```php
     "params": [
        "params.php",
        "?params-local.php"
@@ -118,7 +117,7 @@ The file paths are relative to the [source-directory](#source-directory), which
   It's okay if `params-local.php` will not be found, but it's not okay if `params.php` will be absent.
 
 - `*` - marks wildcard path. It means zero or more matches by wildcard mask.
-  ```
+  ```php
   "web": [
      "../src/Modules/*/config/web.php"
   ]
@@ -128,7 +127,7 @@ The file paths are relative to the [source-directory](#source-directory), which
   files will not be uploaded. In this case, you must explicitly specify each configuration file.
 
 - `$` - reference to another config by its group name.
-  ```
+  ```php
   "params": [
      "params.php",
      "?params-local.php"
@@ -149,8 +148,6 @@ The file paths are relative to the [source-directory](#source-directory), which
 Define your configs like the following:
 
 ```php
-<?php
-
 return [
     'components' => [
         'db' => [
@@ -177,7 +174,7 @@ $config = new Config(
 );
 ```
 
-You can pass `null` as `$params` group name. In this case `$params` will empty array. 
+You can pass `null` as `$params` group name. In this case `$params` will empty array.
 
 ### Using sub-configs
 
@@ -438,7 +435,7 @@ return [
 ];
 ```
 
-If you specify the file path, the remaining sections (`config-plugin-*`) in `composer.json` will be ignored and 
+If you specify the file path, the remaining sections (`config-plugin-*`) in `composer.json` will be ignored and
 configurations will be read from the PHP file specified. The path is relative to where the `composer.json` file
 is located.
 
@@ -650,44 +647,14 @@ composer yii-config-info
 composer yii-config-info yiisoft/widget
 ```
 
-## Testing
-
-### Unit testing
-
-The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
-
-```shell
-./vendor/bin/phpunit --testdox --no-interaction
-```
-
-### Mutation testing
-
-The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
-[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
+## Documentation
 
-```shell
-./vendor/bin/roave-infection-static-analysis-plugin
-```
+- [Internals](docs/internals.md)
 
-### Static analysis
+## Support
 
-The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
-
-```shell
-./vendor/bin/psalm
-```
-
-## License
-
-The config package 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/).
-
-## Credits
-
-The plugin is heavily inspired by [Composer config plugin](https://github.com/yiisoft/composer-config-plugin)
-originally created by HiQDev (https://hiqdev.com/) in 2016 and then adopted by Yii.
+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
 
@@ -700,3 +667,10 @@ originally created by HiQDev (https://hiqdev.com/) in 2016 and then adopted by Y
 [![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
 [![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
 [![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)
+
+## License
+
+The Yii Config package 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/).

composer.json

@@ -13,7 +13,7 @@
         "issues": "https://github.com/yiisoft/config/issues?state=open",
         "forum": "https://www.yiiframework.com/forum/",
         "wiki": "https://www.yiiframework.com/wiki/",
-        "irc": "irc://irc.freenode.net/yii",
+        "irc": "ircs://irc.libera.chat:6697/yii",
         "chat": "https://t.me/yii3en",
         "source": "https://github.com/yiisoft/config"
     },

docs/internals.md

@@ -0,0 +1,45 @@
+# Internals
+
+## Unit testing
+
+The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
+
+```shell
+./vendor/bin/phpunit
+```
+
+## Mutation testing
+
+The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
+[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
+
+```shell
+./vendor/bin/roave-infection-static-analysis-plugin
+```
+
+## Static analysis
+
+The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
+
+```shell
+./vendor/bin/psalm
+```
+
+## Rector
+
+Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or
+use either newest or any specific version of PHP:
+
+```shell
+./vendor/bin/rector
+```
+
+## Composer require checker
+
+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:
+
+```shell
+./vendor/bin/composer-require-checker
+```