Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,22 @@ Do you want to **contribute a failing test**? [This tutorial will show you how](

We would be happy to accept PRs that follow these guidelines.

### Using Docker

A `docker-compose.yml` file is provided to make it easier to run the CI checks locally.
To use it, you need to have Docker installed on your machine, then you can build the image and execute the
above commands in a docker container:

```bash
# Build the docker image
docker compose build

# Run the entire CI suite
compose compose run php complete-check

# Fix the coding standards
docker compose run php fix-cs
```

## Repository layout
Documentation goes into `build/target-repository/docs`.
3 changes: 2 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ FROM php:8-cli-alpine
WORKDIR /etc/rector

# required for composer patches
RUN apk add --no-cache patch
RUN apk add --no-cache patch git

COPY --from=composer:2 /usr/bin/composer /usr/bin/composer

RUN mkdir -p /etc/rector
RUN git config --global --add safe.directory /etc/rector