Please document how to run the tests

phar-io / phive

The Phar Installation and Verification Environment (PHIVE)

https://phar.io

BSD 3-Clause "New" or "Revised" License

581 stars 45 forks source link

Please document how to run the tests #323

Open oliverklee opened 3 years ago

oliverklee commented 3 years ago

I'd like to contribute, but have trouble getting the unit tests to run (so that I can contribute in a test-driven way). The test setup is a bit unlike what I'm used to from other projects. I propose adding a .github/CONTRIBUTING.md file that explains the basics needed for contributing PRs. Thanks! <3

theseer commented 3 years ago

While indeed having a CONTRIBUTING.md is probably a good idea, I'm also a bit confused as to where the issue with running the tests would be?

phive install && ./tools/phpunit

Alternatively, ant -p should have gotten you started - which, as far as I at least was concerned - isn't very uncommon?

oliverklee commented 3 years ago

Ah, I completely missed that PHIVE might also use PHIVE to install its tools. :-)

As far as Ant is concerned, this is the first PHP-based project which I've seen that uses Ant. So no, at least in my experience it's not so common. (I'm working mostly with Symfony and TYPO3.)

theseer commented 3 years ago

Funny, pretty much all my projects and as far as I know all of Sebastian Bergmann's use ANT. So at least in my little bubble, it's quite common ;-)