From 0ada1e64ec98c924d5b83e5227fae601136d25e8 Mon Sep 17 00:00:00 2001 From: Yoanm <4410697+yoanm@users.noreply.github.com> Date: Tue, 2 Sep 2025 18:53:39 +0200 Subject: [PATCH 1/4] Harmonize CI --- .github/workflows/coverage-upload.yml | 2 +- .github/workflows/pre-check-CI-updates.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/coverage-upload.yml b/.github/workflows/coverage-upload.yml index 7953f5d..0d66a5d 100644 --- a/.github/workflows/coverage-upload.yml +++ b/.github/workflows/coverage-upload.yml @@ -9,7 +9,7 @@ permissions: checks: write # For the check run creation ! jobs: - upload: + coverage: name: Coverage permissions: contents: read diff --git a/.github/workflows/pre-check-CI-updates.yml b/.github/workflows/pre-check-CI-updates.yml index 4dde12e..1a9abcc 100644 --- a/.github/workflows/pre-check-CI-updates.yml +++ b/.github/workflows/pre-check-CI-updates.yml @@ -30,7 +30,7 @@ jobs: contents: read uses: ./.github/workflows/reusable-CI-workflow.yml - upload: + coverage: name: Coverage needs: [tests] permissions: From 4afa68771596bfc01d17fc9d020923cb1245f2d9 Mon Sep 17 00:00:00 2001 From: Yoanm <4410697+yoanm@users.noreply.github.com> Date: Tue, 2 Sep 2025 19:01:38 +0200 Subject: [PATCH 2/4] Add CODEOWNERS --- .github/CODEOWNERS | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..a88b281 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @yoanm From 0ff97dbf5574ab14c30c9fdc384d443408c073e4 Mon Sep 17 00:00:00 2001 From: Yoanm <4410697+yoanm@users.noreply.github.com> Date: Tue, 2 Sep 2025 19:15:32 +0200 Subject: [PATCH 3/4] Improve --- .scrutinizer.yml | 1 - README.md | 3 ++- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.scrutinizer.yml b/.scrutinizer.yml index b579dd2..938ad6a 100644 --- a/.scrutinizer.yml +++ b/.scrutinizer.yml @@ -41,7 +41,6 @@ build: variables: CI: 'true' TEST_OUTPUT_STYLE: 'pretty' - COMPOSER_OPTIONS: '--optimize-autoloader' COVERAGE_OUTPUT_STYLE: 'clover' COVERAGE_CLOVER_FILE_PATH: 'build/coverage/clover.xml' PHPCS_DISABLE_WARNING: 'true' diff --git a/README.md b/README.md index 116c026..2fb2083 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ [![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-http-server-swagger-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-http-server-swagger-doc-sdk) [![Code size](https://img.shields.io/github/languages/code-size/yoanm/php-jsonrpc-http-server-swagger-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-http-server-swagger-doc-sdk) -[![Dependabot Status](https://api.dependabot.com/badges/status?host=github\&repo=yoanm/php-jsonrpc-http-server-swagger-doc-sdk)](https://dependabot.com) +![Dependabot Status](https://flat.badgen.net/github/dependabot/yoanm/php-jsonrpc-http-server-swagger-doc-sdk) +![Last commit](https://badgen.net/github/last-commit/yoanm/php-jsonrpc-http-server-swagger-doc-sdk) [![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/php-jsonrpc-http-server-swagger-doc-sdk.svg?label=Scrutinizer\&logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-http-server-swagger-doc-sdk/build-status/master) [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/php-jsonrpc-http-server-swagger-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-http-server-swagger-doc-sdk/?branch=master) From bc8d870f4d4cf97f07c7c8d802853a143f21ea35 Mon Sep 17 00:00:00 2001 From: Yoanm <4410697+yoanm@users.noreply.github.com> Date: Tue, 2 Sep 2025 21:08:57 +0200 Subject: [PATCH 4/4] Improve --- .remarkrc | 6 +++++- CODE_OF_CONDUCT.md | 6 +++--- CONTRIBUTING.md | 32 +++++++++++++++++++------------- Makefile | 8 ++++++++ phpunit.xml.dist | 37 +++++++++++++++++-------------------- 5 files changed, 52 insertions(+), 37 deletions(-) diff --git a/.remarkrc b/.remarkrc index 0527df5..5bf1fca 100644 --- a/.remarkrc +++ b/.remarkrc @@ -1,6 +1,10 @@ { "plugins": [ "remark-preset-lint-consistent", - "remark-preset-lint-recommended" + "remark-preset-lint-recommended", + [ + "remark-lint-list-item-indent", + "space" + ] ] } diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index c4f2952..2d53c83 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -23,13 +23,13 @@ include: Examples of unacceptable behavior by participants include: * The use of sexualized language or imagery and unwelcome sexual attention or - advances + advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or electronic - address, without explicit permission + address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a - professional setting + professional setting ## Our Responsibilities diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12bc460..c9b086e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,33 +1,39 @@ # Contributing ## Getting Started - * Fork, then clone the repo: + +* Fork, then clone the repo: + ```bash git clone git@github.com:your-username/php-jsonrpc-http-server-swagger-doc-sdk.git -```` +``` + +* Make sure everything goes well: - * Make sure everything goes well: ```bash make build make test ``` - * Make your changes (Add/Update tests according to your changes). - * Make sure tests are still green: +* Make your changes (Add/Update tests according to your changes). +* Make sure tests are still green: + ```bash make test ``` - * To check code coverage, launch +* To check code coverage, launch + ```bash make coverage ``` - * Push to your fork and [submit a pull request](https://github.com/yoanm/php-jsonrpc-http-server-swagger-doc-sdk/compare/). - * Wait for feedback or merge. +* Push to your fork and [submit a pull request](https://github.com/yoanm/php-jsonrpc-http-server-swagger-doc-sdk/compare/). +* Wait for feedback or merge. + +Some stuff that will increase your pull request's acceptance: - Some stuff that will increase your pull request's acceptance: - * Write tests. - * Follow PSR-2 coding style. - * Write good commit messages. - * Do not rebase or squash your commits when a review has been made. +* Write tests. +* Follow PSR-2 coding style. +* Write good commit messages. +* Do not rebase or squash your commits when a review has been made. diff --git a/Makefile b/Makefile index fdbc8a1..0c3c84f 100644 --- a/Makefile +++ b/Makefile @@ -109,5 +109,13 @@ scrutinizer-behat: create-build-directories: mkdir -p ${PHPUNIT_COVERAGE_DIRECTORY} ${BEHAT_COVERAGE_DIRECTORY} ${REPORTS_DIRECTORY} +.PHONY: configure-dev-env +configure-dev-env: + npm install --global remark-cli remark-preset-lint-consistent remark-preset-lint-recommended remark-lint-list-item-indent + +.PHONY: lint-markdown +lint-markdown: + npx remark . --output + .PHONY: build install configure test test-unit test-functional codestyle create-build-directories scrutinizer-behat scrutinizer-phpunit .DEFAULT: build diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 4e1847a..0b44794 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -1,8 +1,7 @@ - - - - - - - - tests/Functional/* - - - tests/Technical/* - - - - - - src - - + + + src + + + + + + + + tests/Functional + + + tests/Technical + +