ericlbarnes/codeigniter-simpletest

Improve documentation

Opened this issue · 3 comments

fireproofsocks commented

This library would be a lot more useful if some real-world documentation were included -- this should include basic installation scenarios (e.g. is it even possible to put the test files in a directory outside of document root? All my CodeIgniter files save for index.php are not in the docroot, but I see nothing in the comments or README that let me know if this was written in a way that respects that common scenario).

Here are a few examples:

  • from unit_test.php, What is this?:
    define('MAIN_PATH', realpath(dirname(FILE)).'/');
  • Please put a link back to http://www.simpletest.org/ prominently in your docs -- it's not clear from the de
  • From the README, this is useless: "All test files need to be named test_name_folder.php." -- you give example of the filename, but no explanation of where they're supposed to go. What directory?
  • Please explain your directory structure. I'm used to putting all my tests into one folder. Why would I put some into a folder named "bugs" and others in a folder named "libraries" etc.
  • Update your unit_test.php file so it's clear what areas should NOT be edited. Usually there's a note like "DO NOT EDIT BELOW THIS LINE."
  • Add at least one wiki page please: something that describes the project -- it's not even clear that this is an implementation of http://www.simpletest.org/ (include a link please)

With mediocre documentation, a project can never be more than mediocre.

ericlbarnes commented

I will accept pull requests but the ci core is being converted to
phpunit so it is recommended to use that. You can find the phpunit
code in ci develop branch.

Thanks,
Eric Barnes

On Jul 27, 2012, at 3:57 PM, Everett Griffiths
reply@reply.github.com
wrote:

This library would be a lot more useful if some real-world documentation were included -- this should include basic installation scenarios (e.g. is it even possible to put the test files in a directory outside of document root? All my CodeIgniter files save for index.php are not in the docroot, but I see nothing in the comments or README that let me know if this was written in a way that respects that common scenario).

Here are a few examples:

  • from unit_test.php, What is this?:
    define('MAIN_PATH', realpath(dirname(FILE)).'/');
  • Please put a link back to http://www.simpletest.org/ prominently in your docs -- it's not clear from the de
  • From the README, this is useless: "All test files need to be named test_name_folder.php." -- you give example of the filename, but no explanation of where they're supposed to go. What directory?
  • Please explain your directory structure. I'm used to putting all my tests into one folder. Why would I put some into a folder named "bugs" and others in a folder named "libraries" etc.
  • Update your unit_test.php file so it's clear what areas should NOT be edited. Usually there's a note like "DO NOT EDIT BELOW THIS LINE."
  • Add at least one wiki page please: something that describes the project -- it's not even clear that this is an implementation of http://www.simpletest.org/ (include a link please)

With mediocre documentation, a project can never be more than mediocre.

Reply to this email directly or view it on GitHub:
#16

aisensiy commented

I like simple test better than phpunit...

purdy commented

I'd love an example of how to test a controller. I don't think the core is being updated to PHPUnit ... at least it doesn't appear to have since a year ago and with the current future of CI up in the air, I don't see it happening anytime soon.