Skip to content

Update the README and documentation#42

Open
mpdude wants to merge 6 commits intoFriendsOfBehat:masterfrom
mpdude:update-readme
Open

Update the README and documentation#42
mpdude wants to merge 6 commits intoFriendsOfBehat:masterfrom
mpdude:update-readme

Conversation

@mpdude
Copy link

@mpdude mpdude commented Dec 17, 2025

This updates the README and improves documentation a bit.

As requested in #42 (review), the README is a copy from the original upstream repo with only slight changes.

Closes #27.

mpdude added a commit to mpdude/MinkExtension that referenced this pull request Dec 17, 2025
Squash-merge of FriendsOfBehat#42.

Squashed commit of the following:

commit 3232451
Author: Matthias Pigulla <mp@webfactory.de>
Date:   Wed Dec 17 13:42:33 2025 +0100

    Update the README and documentation
Copy link

@aik099 aik099 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see that you've changed documentation and changed a documentation file format in the same PR. This makes it hard to review.

Could you instead:

  1. change documentation format in this PR
  2. create another PR with documentation changes (you can only create it after the documentation format change PR is merged)

@aik099
Copy link

aik099 commented Dec 18, 2025

@stof , could you please grant me more access to this repo. Right now I'm unable to:

  • merge PRs
  • approve GitHub Actions execution for new contributor PRs ("1 workflow awaiting approval")
  • probably something else

The access level that I have on minkphp organization should be sufficient 😄 .

README.md Outdated
@@ -1,5 +1,18 @@
This is the fork of MinkExtension library that supports PHP `>=7.4` and supports Symfony `>=4.4`.
# Mink Extension for Behat
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could start with a copy/paste of README of the original repository (see https://github.com/Behat/MinkExtension) with some parts (about abandoned repo) omitted.

That would ease the review. As another PR we improve README contents. This way it's easier to understand what was changed into what.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea.

Copy link
Author

@mpdude mpdude Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As requested, I have changed the README to be what the original repository had, only with the part about the fork being removed.

Will open a separate PR for my README suggestions after we get this one here merged.

@stof
Copy link
Member

stof commented Dec 18, 2025

@aik099 I cannot. Only @pamil is owner of this organization.

@mpdude
Copy link
Author

mpdude commented Dec 18, 2025

If you guys agree I'll migrate to markdown first in a new PR, then later rebase this one and other ones affecting documentation.

@mpdude
Copy link
Author

mpdude commented Dec 18, 2025

Let's first get #45 merged, then I'll rebase this one here.

@mpdude
Copy link
Author

mpdude commented Dec 19, 2025

Rebased. Now it's much clearer to see what I intended.

@mpdude mpdude requested review from aik099 and stof January 14, 2026 17:49
* `mink_loader` - path to a file loaded to make Mink available (useful when
using the PHAR archive for Mink, useless when using Composer)

## Adding your own or other drivers
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should mention somewhere than friends-of-behat/symfony-extension registers a browserkit_symfony driver factory (or maybe just symfony, I don't remember the exact name) ?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean as an example?

We cannot have a complete list here of every other extension that adds drivers.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

both as an example, and as a reference because it is an extension of the same organization.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mpdude and others added 4 commits January 14, 2026 19:06
Co-authored-by: Christophe Coevoet <stof@notk.org>
Co-authored-by: Christophe Coevoet <stof@notk.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The readme needs to be updated

3 participants