From f85cff4d1c95c5ffb0c0722ba97661be34cca083 Mon Sep 17 00:00:00 2001 From: John Hirbour Date: Thu, 9 Oct 2014 11:10:44 -0700 Subject: added sectiosn for demo, testing and contributing --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 7c07b079..e5e61e84 100644 --- a/README.md +++ b/README.md @@ -45,3 +45,73 @@ Then you can include the autoloader, and you will have access to the library cla help: + + [echo] + + Welcome to use PRADO build script! + ---------------------------------- + You may use the following command format to build a target: + + phing + + where can be one of the following: + + For all PRADO developers: + - test : run unit tests (results are under /build/test-reports) + - coverage : run unit tests collecting coverage informations + - lint : run lint on framework + - lint-demos : run lint on demos +``` + + +## Contributing + +In the spirit of free software, **everyone** is encouraged to help improve this project. + +Here are some ways *you* can contribute: + +* by using prerelease versions +* by reporting bugs +* by writing specifications +* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace) +* by refactoring code +* by resolving issues +* by reviewing patches + +Starting point: + +* Fork the repo +* Clone your repo +* Make your changes +* Write tests for your changes to ensure that later changes to prado won't break your code. +* Submit your pull request + -- cgit v1.2.3