Permalink
Browse files

Update CONTRIBUTING.md

  • Loading branch information...
1 parent ed381c3 commit 80576d7923f3819ff7a21a6a31043c6aade4ab94 @marcqualie marcqualie committed Aug 7, 2013
Showing with 21 additions and 18 deletions.
  1. +21 −18 CONTRIBUTING.md
View
@@ -1,29 +1,32 @@
-CONTRIBUTING
-============
+# Contributing
-Contributions are **welcome** and will be fully **credited** <3
+Contributions are **welcome** and will be fully **credited**.
-**StatsD** will use the [Symfony2 Coding Standard](http://symfony.com/doc/current/contributing/code/standards.html).
-The easiest way to apply these conventions is to install [PHP_CodeSniffer](http://pear.php.net/package/PHP_CodeSniffer)
-and the [Opensky Symfony2 Coding Standard](https://github.com/opensky/Symfony2-coding-standard).
+We accept contributions via Pull Requests on [Github](https://github.com/php-loep/statsd).
-You may be interested in [PHP Coding Standards Fixer](https://github.com/fabpot/PHP-CS-Fixer).
-Installation
-------------
+## Pull Requests
-``` bash
-$ pear install PHP_CodeSniffer
-$ cd `pear config-get php_dir`/PHP/CodeSniffer/Standards
-$ git clone git://github.com/opensky/Symfony2-coding-standard.git Symfony2
-$ phpcs --config-set default_standard Symfony2
-```
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the README and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow semver. Randomly breaking public APIs is not an option.
-Usage
------
+- **Create topic branches** - Don't ask us to pull from your master branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
+
+
+## Running Tests
``` bash
-$ phpcs src/
+$ phpunit
```
+
**Happy coding**!

0 comments on commit 80576d7

Please sign in to comment.