Permalink
Browse files

Create `CONTRIBUTING.md` & `README.md` files

  • Loading branch information...
1 parent 589ae8b commit 2b73cf3f2fbfbd9de854e74b16631052232818c2 @stloyd stloyd committed Nov 15, 2012
Showing with 26 additions and 0 deletions.
  1. +10 −0 CONTRIBUTING.md
  2. +16 −0 README.md
View
@@ -0,0 +1,10 @@
+Contributing
+------------
+
+__phpspec2__ is an open source, community-driven project. If you'd like to contribute, feel free to do this, but remember to follow this few simple rules:
+
+- Make your feature addition or bug fix,
+- __Always__ as base for your changes use `develop` branch (all new development happens here, `master` branch is for releases & hotfixes only),
+- __Important__: to prevent unintentional breaks in future, please add _specs_ for those changes (please look into `spec/` folder for some examples),
+- Commit your code, but do not mess with `CHANGES.md` file,
+- __Remember__: when you create Pull Request, always select `develop` branch as target, otherwise it will be closed.
View
@@ -0,0 +1,16 @@
+phpspec2
+========
+
+- [master](https://github.com/phpspec/phpspec2) ([![Master Build Status](https://secure.travis-ci.org/phpspec/phpspec2.png?branch=master)](http://travis-ci.org/phpspec/phpspec2)) - staging branch. Last stable version.
+- [develop](https://github.com/phpspec/phpspec2/tree/develop) ([![Develop Build Status](https://secure.travis-ci.org/phpspec/phpspec2.png?branch=develop)](http://travis-ci.org/phpspec/phpspec2)) - development branch. Development happens here and you should send your PRs here too.
+
+Useful Links
+------------
+
+- The main website with documentation is at [http://phpspec.net](http://phpspec.net)
+
+Installing Dependencies
+-----------------------
+
+ wget -nc http://getcomposer.org/composer.phar
+ php composer.phar install

0 comments on commit 2b73cf3

Please sign in to comment.