Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Discussion: Improve PHP track docs for PHPUnit / composer #864

Open
mk-mxp opened this issue Nov 17, 2024 · 7 comments
Open

Discussion: Improve PHP track docs for PHPUnit / composer #864

mk-mxp opened this issue Nov 17, 2024 · 7 comments
Assignees

Comments

@mk-mxp
Copy link
Contributor

mk-mxp commented Nov 17, 2024

I think our track docs make things too complicated for new students.

Right after the required installation of PHP we have a short paragraph about installing composer. For PHPUnit we then describe composer as the main means of installation. Using the PHPUnit PHAR is last and "optional". But composer is not required to solve Exercism exercises.

The easiest way to use PHPUnit for Exercism is downloading the PHAR. So we should provide tutorial-style instructions on that first. Also we should check, that exercism test runs the PHAR when using these instructions.

In a more optional looking paragraph we may then describe and explain composer and PHPUnit installation using it. There is a nice short description of composer and installation we may use to improve the composer introduction and installation. We should also mention that composer is wide-spread in the PHP ecosystem.

@tomasnorre
Copy link
Contributor

That sounds like a good approach.

@almin-dolic
Copy link

Hi @mk-mxp and @tomasnorre,
is this change still wanted? I'd be happy to update the docs to make PHPUnit PHAR the default method and improve the explanation of Composer as an optional approach. Let me know if this is still relevant! 😊

@tomasnorre
Copy link
Contributor

I would say it's still wanted :) Would be happy to review the PR.

@A-O-Emmanuel
Copy link

Hi @mk-mxp and @tomasnorre has this issue been resolved? I would like to give it a go, please let me know if it's still needed.

@tomasnorre
Copy link
Contributor

I think @almin-dolic already signed up for it. But not head anything final back. Lets give Almin a change to answer first.

@A-O-Emmanuel
Copy link

Alright, agreed, thanks for your response.

@mk-mxp
Copy link
Contributor Author

mk-mxp commented Feb 15, 2025

Whoever works on this:

  • Fork this repository and edit the file docs/INSTALLATION.md
  • Create a PR as soon as possible, so we can discuss the changes early
  • The composer instructions mentioned above have moved and we should link to the website, not steal the Markdown :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants