From 2b602b490c0900ab02f68e673b4b13c34ec4dc50 Mon Sep 17 00:00:00 2001 From: Everett Griffiths Date: Tue, 20 Oct 2015 13:43:28 -0700 Subject: [PATCH 1/3] Added example for testsuite --- src/5.2/en/organizing-tests.xml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/5.2/en/organizing-tests.xml b/src/5.2/en/organizing-tests.xml index 6b74d576a..a47af5d2e 100644 --- a/src/5.2/en/organizing-tests.xml +++ b/src/5.2/en/organizing-tests.xml @@ -121,13 +121,18 @@ OK (2 test, 2 assertions) Composing a Test Suite Using XML Configuration - - tests + + tests/Unit ]]> + + Specify the testsuite using the --testsuite option: + + phpunit --testsuite "prod" + If phpunit.xml or phpunit.xml.dist (in that order) exist in the From 01675a6f631921d768c13a2836f3da51ad7816d5 Mon Sep 17 00:00:00 2001 From: Everett Griffiths Date: Wed, 21 Oct 2015 09:08:36 -0700 Subject: [PATCH 2/3] Added example for --testsuite option --- src/4.8/en/organizing-tests.xml | 7 ++++++- src/5.0/en/organizing-tests.xml | 7 ++++++- src/5.1/en/organizing-tests.xml | 7 ++++++- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/src/4.8/en/organizing-tests.xml b/src/4.8/en/organizing-tests.xml index ad3c1f824..24acf886c 100644 --- a/src/4.8/en/organizing-tests.xml +++ b/src/4.8/en/organizing-tests.xml @@ -121,13 +121,18 @@ OK (2 test, 2 assertions) Composing a Test Suite Using XML Configuration - + tests ]]> + + Specify the testsuite using the --testsuite option: + + phpunit --testsuite "prod" + If phpunit.xml or phpunit.xml.dist (in that order) exist in the diff --git a/src/5.0/en/organizing-tests.xml b/src/5.0/en/organizing-tests.xml index 0656e63b8..830154d1f 100644 --- a/src/5.0/en/organizing-tests.xml +++ b/src/5.0/en/organizing-tests.xml @@ -121,13 +121,18 @@ OK (2 test, 2 assertions) Composing a Test Suite Using XML Configuration - + tests ]]> + + Specify the testsuite using the --testsuite option: + + phpunit --testsuite "prod" + If phpunit.xml or phpunit.xml.dist (in that order) exist in the diff --git a/src/5.1/en/organizing-tests.xml b/src/5.1/en/organizing-tests.xml index 1d5124d13..a02bf3e70 100644 --- a/src/5.1/en/organizing-tests.xml +++ b/src/5.1/en/organizing-tests.xml @@ -121,13 +121,18 @@ OK (2 test, 2 assertions) Composing a Test Suite Using XML Configuration - + tests ]]> + + Specify the testsuite using the --testsuite option: + + phpunit --testsuite "prod" + If phpunit.xml or phpunit.xml.dist (in that order) exist in the From 7be8bf0be40cf2d82f49fa93b3312d53f227d618 Mon Sep 17 00:00:00 2001 From: Everett Griffiths Date: Wed, 21 Oct 2015 09:33:37 -0700 Subject: [PATCH 3/3] Added bare-bones instructions --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..b72b08da8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing guidelines + +These are guidelines for contributing to the PHPunit documentation. Before submitting a new issue or opening a new PR, please search to see if the same issue/PR already exists. + + +## Submit an issue + +[Submit an Issue](https://github.com/sebastianbergmann/phpunit-documentation/issues) -- please specify the version number and a URL of the the problem. + +## Fixing an Issue + +The steps here may change in the future, but currently if you wish to contribute to the PHPunit documentation, follow the following steps: + +1. Fork the [PHPunit Repository](https://github.com/sebastianbergmann/phpunit-documentation/issues) +2. Clone your fork to your local environment. +3. The documentation files exist as XML files inside the `src/` directory, organized by version and locale, e.g. `src/5.2/en/`. The last URL segment from [https://phpunit.de/manual/](https://phpunit.de/manual/) corresponds to the XML file basename, e.g. the `https://phpunit.de/manual/4.8/en/organizing-tests.html` page is generated by the `src/4.8/en/organizing-tests.xml` file. When making an edit to an existing page, make the changes to all versions that apply. For example, if you wish to edit the `organizing-tests.xml` file, you may need to make the change inside the `4.8`, `5.0`, `5.1`, and `5.2` directories. +4. Commit and push your fixes to your fork. +5. Open a pull request from your fork to the `sebastianbergmann/phpunit-documentation` repo. Make sure you reference the relevant issue number.