Contributing Documentation
jambonrose opened this issue · comments
There is currently no section in the Read Me about how to contribute to the project. Most noticeably, there is nothing about how to properly test the project to ensure that pull-requests aren't introducing problems.
As far as I can tell, nosetests
and behave
are meant to be used.
The tests work just fine (13 tests pass on Python 3.4). The feature checks do not (on my machine):
$ behave
0 features passed, 5 failed, 0 skipped
0 scenarios passed, 5 failed, 0 skipped
5 steps passed, 5 failed, 29 skipped, 0 undefined
Took 0m0.292s
I am not familiar with behave
and perhaps the error is with my environment. Without any documentation to inform me what my development environment should be, it's hard to tell.
the output you eventually want to see looks like this:
One thing that isn't documented is that you need to run pip install -e .
or python setup.py install .
so that your local captainhook is made available.
Is there any output to the behave command other than the 3 lines you show above?
Any explanation as to why they fail?