From 5dd338baf91aa72834ee029d8b736d0115c3d9b6 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 10 Mar 2026 21:59:10 +0000 Subject: [PATCH 1/2] Update CONTRIBUTING.md with current project info MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Fix typo ("highlihting" → "highlighting") and grammar issues - Add PHP version requirement (^8.0) - Document available Makefile targets (test, csfix, psalm, build) - Reorganize with clearer sections for Docker and local development https://claude.ai/code/session_01CSKtAMgtepUahGCezKbrgs --- CONTRIBUTING.md | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c1f81b7..242d7980 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,11 +5,11 @@ How Can I Contribute? ## Reporting Bugs To report bugs you can open an issue on this repository. Please provide as much information as you can to help discover and fix the bug. -Useful information are: +Useful information includes: - Which PHP version are you running? - Which problem are you experiencing? -If possible, a test highlihting the bug would be great. +If possible, a test highlighting the bug would be great. If you are fixing a bug, create a pull request, linking the issue with bug's details (if there is any) and provide tests. The build must be green for the PR being merged. @@ -21,8 +21,15 @@ The build must be green for the PR being merged. ## How to develop arkitect -In order to fix a bug or submit a new enhancement we suggest to run the build locally or using docker (with the dockerfile provided). -Some common tasks are available in the Makefile file (you still can use it to see how run things even your system does not support make). +### Requirements + +- PHP `^8.0` +- Composer + +### Using Docker + +In order to fix a bug or submit a new enhancement we suggest running the build locally or using Docker (with the Dockerfile provided). +Some common tasks are available in the Makefile (you can still use it to see how to run things even if your system does not support make). To create the docker image and then enter the docker container shell: @@ -31,7 +38,7 @@ docker image build -t phparkitect . docker run --rm -it --entrypoint= -v $(PWD):/arkitect phparkitect bash ``` -If you prefer use more shorter make commands (use `make` without arguments for help): +If you prefer, you can use shorter make commands (use `make` without arguments for help): ```shell make dbi @@ -43,3 +50,19 @@ The first time, after the docker container has been created, remember to install ```shell composer install ``` + +### Running the build locally + +You can run the full build (code style fix, static analysis, and tests) with: + +```shell +make build +``` + +Or run individual tasks: + +```shell +make test # run tests +make csfix # run code style fixer +make psalm # run static analysis +``` From ac4a22c0cf078ff4fb96df2f5c0636f2bc2d50e5 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 10 Mar 2026 22:07:08 +0000 Subject: [PATCH 2/2] Reorder CONTRIBUTING.md to prioritize local development over Docker Local development is now presented as the primary workflow, with Docker as an alternative for those who prefer not to install PHP locally. https://claude.ai/code/session_01CSKtAMgtepUahGCezKbrgs --- CONTRIBUTING.md | 41 ++++++++++++++++++++++------------------- 1 file changed, 22 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 242d7980..c539ccb8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,43 +26,46 @@ The build must be green for the PR being merged. - PHP `^8.0` - Composer -### Using Docker +### Getting started -In order to fix a bug or submit a new enhancement we suggest running the build locally or using Docker (with the Dockerfile provided). -Some common tasks are available in the Makefile (you can still use it to see how to run things even if your system does not support make). - -To create the docker image and then enter the docker container shell: +Install dependencies: ```shell -docker image build -t phparkitect . -docker run --rm -it --entrypoint= -v $(PWD):/arkitect phparkitect bash +composer install ``` -If you prefer, you can use shorter make commands (use `make` without arguments for help): +Some common tasks are available in the Makefile (run `make` without arguments for help). + +You can run the full build (code style fix, static analysis, and tests) with: ```shell -make dbi -make shell +make build ``` -The first time, after the docker container has been created, remember to install the packages with composer: +Or run individual tasks: ```shell -composer install +make test # run tests +make csfix # run code style fixer +make psalm # run static analysis ``` -### Running the build locally +### Using Docker instead -You can run the full build (code style fix, static analysis, and tests) with: +If you prefer not to install PHP locally, you can use the provided Dockerfile. + +Build the image and enter the container shell: ```shell -make build +make dbi +make shell ``` -Or run individual tasks: +Or manually: ```shell -make test # run tests -make csfix # run code style fixer -make psalm # run static analysis +docker image build -t phparkitect . +docker run --rm -it --entrypoint= -v $(PWD):/arkitect phparkitect bash ``` + +Once inside the container, install dependencies with `composer install` and then use the same `make` commands described above.