Add Feature to Gherkin topic #32
Conversation
belgoros
commented
Jul 4, 2016
belgoros
commented
- create gherkin.md
- add feature introduction section
- add step definitions section
* create gherkin.md * add feature introduction section * add step definitions section
|
Thanks @javix - dd you write this from scratch or pull it from somewhere else? I have the feeling I've read some of this before. |
|
Sure, I've taken it from the old wiki https://github.com/cucumber/cucumber/wiki |
|
|
||
| Gherkin serves two purposes — documentation and automated tests. The third is a bonus feature — when it yells in red it’s talking to you, telling you what code you should write. | ||
|
|
||
| Gherkin’s grammar is defined in the Treetop grammar that is part of the Cucumber codebase. The grammar exists in different flavours for many spoken languages (37 at the time of writing), so that your team can use the keywords in your own language. |
There was a problem hiding this comment.
This is pretty technical for an introduction. I think all we should mention is that a lot of spoken languages (much more than 37 nowadays I believe) are supported. Keeping the part about why this matters (i.e. use the language of your team/project) is good though.
There was a problem hiding this comment.
It's also out of date - we haven't used Treetop for several years now.
There was a problem hiding this comment.
@mattwynne the Treetop mention has been removed in #34.
|
Not your fault @javix but I think this content is pretty crap. It's over-technical and doesn't provide a simple, accessible introduction to Gherkin and how to use it. I think we need to avoid lifting content as-is from the old wiki - we need to do some quality checking as we do. |
|
@mattwynne sure, I'll try to do my best. I feel like an author preparing his book and who has to apply corrections provided by his editor, all that will always give the best result for the future readers 😄 |
|
I know it must be tiring @javix and thanks for your patience. I think we'll soon build some momentum and things will feel more satisfying for you. |
|
@mattwynne no worries, this is my real first experience of writing docs, especially for the tool I love. So I'm patient and shall |
|
This is obsolete - superseded by #34 |
|
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
