Add "CONTRIBUTING.md"

Author: rougin

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing
+
+To ensure a smooth and effective collaboration, kindly follow the guidelines below.
+
+## Raising issues
+
+* **Open an issue first** - before working on a change, create an issue to discuss it.
+* **Example issue title** - `Error when running the route`
+
+> [!NOTE]
+> This prevents duplicated work and ensures the change aligns with the project's goals.
+
+## Pull requests
+
+- **Reference the issue** - create a pull request (PR) once the issue is approved.
+- **Keep it focused** - each PR should address only one issue.
+
+> [!NOTE]
+> A PR title must reference the issue number (e.g., `#1 - Fix for running the route`).
+
+## Workflow
+
+Code must adhere to the project's standards before submitting.
+
+* **Automated tests** - new features and bug fixes must include `phpunit` tests.
+```bash
+$ composer test
+```
+
+* **Code quality** - check for potential bugs and errors with `phpstan`.
+```bash
+$ composer analyze
+```
+
+* **Coding style** - automatically format code with `php-cs-fixer`.
+```bash
+$ composer restyle
+```
+
+> [!NOTE]
+> Bug fixes should add a test that fails without the fix.

README.md

@@ -441,77 +441,13 @@ interface WithPayload
 }
 ```
 
-## Testing
+## Change log
 
-If there is a need to check the source code of `Authsum` for development purposes (e.g., creating fixes, new features, etc.), kindly clone this repository first to a local machine:
+Please see [CHANGELOG][link-changelog] for more recent changes.
 
-``` bash
-$ git clone https://github.com/rougin/authsum.git "Sample"
-```
-
-After cloning, use `Composer` to install its required packages:
-
-``` bash
-$ cd Sample
-$ composer update
-```
-
-> [!NOTE]
-> Please see also the [build.yml](https://github.com/rougin/authsum/blob/master/.github/workflows/build.yml) of `Authsum` to check any packages that needs to be installed based on the PHP version.
-
-Once the required packages were installed, kindly check the following below on how to maintain the code quality and styling guide when interacting the source code of `Authsum`:
-
-### Unit tests
-
-`Authsum` also contains unit tests that were written in [PHPUnit](https://phpunit.de/index.html):
-
-``` bash
-$ composer test
-```
-
-When creating fixes or implementing new features, it is recommended to run the above command to always check if the updated code introduces errors during development.
-
-### Code quality
-
-To retain the code quality of `Authsum`, a static code analysis code tool named [PHPStan](https://phpstan.org/) is being used during development. To start, kindly install the specified package in the global environment of `Composer`:
-
-``` bash
-$ composer global require phpstan/phpstan --dev
-```
-
-Once installed, `PHPStan` can now be run using its namesake command:
-
-``` bash
-$ cd Sample
-$ phpstan
-```
-
-> [!NOTE]
-> When running `phpstan`, it will use the `phpstan.neon` file which is already provided by `Authsum`.
-
-### Coding style
-
-Aside from code quality, `Authsum` also uses a tool named [PHP Coding Standards Fixer](https://cs.symfony.com/) for maintaining an opinionated style guide. To use this tooling, it needs also to be installed in the `Composer`'s global environment first:
-
-``` bash
-$ composer global require friendsofphp/php-cs-fixer --dev
-```
-
-After its installation, kindly use the `php-cs-fixer` command in the same `Authsum` directory:
-
-``` bash
-$ cd Sample
-$ php-cs-fixer fix --config=phpstyle.php
-```
-
-The `phpstyle.php` file provided by `Authsum` currently follows the [PSR-12](https://www.php-fig.org/psr/psr-12/) standard as its baseline for the coding style and uses [Allman](https://en.wikipedia.org/wiki/Indentation_style#Allman_style) as its indentation style.
-
-> [!NOTE]
-> Installing both `PHPStan` and `PHP Coding Standards Fixer` requires a minimum version of PHP at least `7.4`.
-
-## Changelog
+## Contributing
 
-Please see [CHANGELOG][link-changelog] for more information what has changed recently.
+See [CONTRIBUTING][link-contributing] on how to contribute.
 
 ## License
 
@@ -525,6 +461,7 @@ The MIT License (MIT). Please see [LICENSE][link-license] for more information.
 
 [link-build]: https://github.com/rougin/authsum/actions
 [link-changelog]: https://github.com/rougin/authsum/blob/master/CHANGELOG.md
+[link-contributing]: https://github.com/rougin/authsum/blob/master/CONTRIBUTING.md
 [link-contributors]: https://github.com/rougin/authsum/contributors
 [link-coverage]: https://app.codecov.io/gh/rougin/authsum
 [link-downloads]: https://packagist.org/packages/rougin/authsum