Skip to content
This repository was archived by the owner on Apr 12, 2018. It is now read-only.

Added example for testsuite #329

Closed
wants to merge 3 commits into from
Closed
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
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 6 additions & 1 deletion src/4.8/en/organizing-tests.xml
Original file line number Diff line number Diff line change
Expand Up @@ -121,13 +121,18 @@ OK (2 test, 2 assertions)</screen>
<title>Composing a Test Suite Using XML Configuration</title>
<programlisting><![CDATA[<phpunit bootstrap="src/autoload.php">
<testsuites>
<testsuite name="money">
<testsuite name="prod">
<directory>tests</directory>
</testsuite>
</testsuites>
</phpunit>]]></programlisting>
</example>

<para>
Specify the testsuite using the <literal>--testsuite</literal> option:
</para>
<screen><userinput>phpunit --testsuite "prod"</userinput>

<para>
If <filename>phpunit.xml</filename> or
<filename>phpunit.xml.dist</filename> (in that order) exist in the
Expand Down
7 changes: 6 additions & 1 deletion src/5.0/en/organizing-tests.xml
Original file line number Diff line number Diff line change
Expand Up @@ -121,13 +121,18 @@ OK (2 test, 2 assertions)</screen>
<title>Composing a Test Suite Using XML Configuration</title>
<programlisting><![CDATA[<phpunit bootstrap="src/autoload.php">
<testsuites>
<testsuite name="money">
<testsuite name="prod">
<directory>tests</directory>
</testsuite>
</testsuites>
</phpunit>]]></programlisting>
</example>

<para>
Specify the testsuite using the <literal>--testsuite</literal> option:
</para>
<screen><userinput>phpunit --testsuite "prod"</userinput>

<para>
If <filename>phpunit.xml</filename> or
<filename>phpunit.xml.dist</filename> (in that order) exist in the
Expand Down
7 changes: 6 additions & 1 deletion src/5.1/en/organizing-tests.xml
Original file line number Diff line number Diff line change
Expand Up @@ -121,13 +121,18 @@ OK (2 test, 2 assertions)</screen>
<title>Composing a Test Suite Using XML Configuration</title>
<programlisting><![CDATA[<phpunit bootstrap="src/autoload.php">
<testsuites>
<testsuite name="money">
<testsuite name="prod">
<directory>tests</directory>
</testsuite>
</testsuites>
</phpunit>]]></programlisting>
</example>

<para>
Specify the testsuite using the <literal>--testsuite</literal> option:
</para>
<screen><userinput>phpunit --testsuite "prod"</userinput>

<para>
If <filename>phpunit.xml</filename> or
<filename>phpunit.xml.dist</filename> (in that order) exist in the
Expand Down
9 changes: 7 additions & 2 deletions src/5.2/en/organizing-tests.xml
Original file line number Diff line number Diff line change
Expand Up @@ -121,13 +121,18 @@ OK (2 test, 2 assertions)</screen>
<title>Composing a Test Suite Using XML Configuration</title>
<programlisting><![CDATA[<phpunit bootstrap="src/autoload.php">
<testsuites>
<testsuite name="money">
<directory>tests</directory>
<testsuite name="prod">
<directory>tests/Unit</directory>
</testsuite>
</testsuites>
</phpunit>]]></programlisting>
</example>

<para>
Specify the testsuite using the <literal>--testsuite</literal> option:
</para>
<screen><userinput>phpunit --testsuite "prod"</userinput>

<para>
If <filename>phpunit.xml</filename> or
<filename>phpunit.xml.dist</filename> (in that order) exist in the
Expand Down