From 47b4071b253a08f454f1e716c45b9ca0605cc2e4 Mon Sep 17 00:00:00 2001 From: mesilov Date: Wed, 28 Aug 2024 01:45:51 +0600 Subject: [PATCH] Update testing commands and linting instructions Streamlined the test running instructions and corrected linting commands in the CONTRIBUTING.md. Fixed a typo in the coding standards section and ensured consistent capitalization for GitHub references. Signed-off-by: mesilov --- CONTRIBUTING.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14eb68a4..2a796ee0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,10 +5,7 @@ 1. Fork the repo 2. Clone the repo to local 3. Install dependencies: `composer update` (this assumes you have 'composer' aliased to wherever your composer.phar lives) -4. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate: - `composer phpstan-analyse` - `composer phpunit-run-unit-tests` - `composer phpunit-run-integration-tests` +4. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate. ## Adding new features @@ -19,10 +16,12 @@ New features that does not have any BC Breaks are going to be added in next mino ## Codding standards -In order to fix codding standards please exeecute: +In order to fix codding standards please execute: ```shell -composer phpstan-analyse +make lint-phpstan +make lint-rector +make lint-rector-fix ``` ## Patches and bugfixes @@ -36,4 +35,4 @@ composer phpstan-analyse 1. Make the changes/additions to the code, committing often and making clear what you've done 2. Make sure you write tests for your code, located in the folder structure 3. Run your tests (often and while coding) -4. Create Pull Request on github to against proper branch +4. Create Pull Request on GitHub to against proper branch