Adding contrib file

xwp · Sep 16, 2014 · 58c0fdc · 58c0fdc
1 parent a5daec8
commit 58c0fdc
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 14 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,13 @@
+Contributing
+-------------
+
+Before you contribute code to PHP\_CodeSniffer, please make sure it conforms to the PEAR coding standard and that the PHP\_CodeSniffer unit tests still pass. The easiest way to contribute is to work on a checkout of the repository, or your own fork, rather than an installed PEAR version. If you do this, you can run the following commands to check if everything is ready to submit:
+
+    cd PHP_CodeSniffer
+    php scripts/phpcs --ignore=*/tests/* . -n
+
+Which should give you no output, indicating that there are no PEAR coding standard errors. And then:
+
+    phpunit
+
+Which should give you no failures or errors. You can ignore any skipped tests as these are for external tools.
diff --git a/README.markdown → README.md b/README.markdown → README.md
@@ -50,21 +50,12 @@ The documentation for PHP\_CodeSniffer is available on the [Github wiki](https:/
 
 Information about upcoming features and releases is available on the [Squiz Labs blog](http://www.squizlabs.com/php-codesniffer).
 
-Contributing
--------------
-
-If you do contribute code to PHP\_CodeSniffer, please make sure it conforms to the PEAR coding standard and that the PHP\_CodeSniffer unit tests still pass. The easiest way to contribute is to work on a checkout of the repository, or your own fork, rather than an installed PEAR version. If you do this, you can run the following commands to check if everything is ready to submit:
-
-    cd PHP_CodeSniffer
-    php scripts/phpcs --ignore=*/tests/* . -n
-
-Which should give you no output, indicating that there are no PEAR coding standard errors. And then:
-
-    phpunit tests/AllTests.php
-
-Which should give you no failures or errors. You can ignore any skipped tests as these are for external tools.
-
 Issues
 ------
 
 Bug reports and feature requests can be submitted on the [Github Issue Tracker](https://github.com/squizlabs/PHP_CodeSniffer/issues) or the [PEAR bug tracker](http://pear.php.net/package/PHP_CodeSniffer/bugs).
+
+Contributing
+-------------
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for information.