Cucumber-jvm: Severe lack of documentation for Cucumber-Clojure

Created on 24 Sep 2014 · 16Comments · Source: cucumber/cucumber-jvm

There is basically no documentation for Cucumber-Closure which makes the framework next to useless.

Source

stormcoder

👎1

All 16 comments

Cucumber-JVM is open source, developed in developers' spare time. We're relying on the community to help with the documentation. A good place to start would be in Cucumber-Clojure's README.md.

Are you willing to help? Or are you expecting other volunteers to do the job for you?

aslakhellesoy on 24 Sep 2014

Since I am the one asking for documentation on how to use the framework, I am probably not the right person to write that documentation. If someone were to explain to me how to use the framework, I would be more than happy to right up a tutorial. However, every where I ask for information, no one provides any useful information. And since all I get from the developers is push back when I ask for information, the only people left who can write that documentation are the developers. You either need to provide some documentation or sit down and answer questions. No one here seems willing to do either.

So you complain about me not reading the readme but you just created that readme 34 minutes ago. The readme consists of a link to an out dated example repositories and a link to a not very useful example. The first one is for Cukes which is not Cucumber-jvm but an old project that used Cucumber for ruby, And the second link doesn't answer my questions. If you look at https://github.com/cucumber/cucumber-jvm/blob/master/clojure/src/test/resources/cucumber/runtime/clojure/stepdefs.clj there is no ns macro and no require or import function so how are the definitions for Before, When etc imported into the steps file? What is the correct namespace to use with a :require?

stormcoder on 24 Sep 2014

Boo hoo. Cry me a river.

aslakhellesoy on 25 Sep 2014

👎2

Wow. I guess that answers why no one had any answers for me. No one is using the framework. What an asshole. Piss off.

stormcoder on 25 Sep 2014

👎2

When you start a conversation with an insult you should be prepared to either be ignored or to receive another insult in reply.

Despite your initial insulting message (labelling something free as useless in the forum of the creators is an insult) I created a brand new README.md to give you and others a starting point for documentation. Then you proceed with:

So you complain about me not reading the readme but you just created that readme 34 minutes ago.

Where am I complaining? I created the README to help you.

Then you proceed with more ridiculous claims:

The readme consists of a link to an out dated example repositories and a link to a not very useful example. The first one is for Cukes which is not Cucumber-jvm but an old project that used Cucumber for ruby

The first example is an example in the cucumber-jvm git repo, and it uses _clojure_ and _leiningen_. What makes you think it's for ruby? What is outdated about it?

The only other place I have seen you asking is in #779 where I redirected you to the mailing list for general questions. Cucumber is a community with thousands of users. We have to keep the bug tracker free of general discussions to prevent it from growing into thousands of open tickets. Google groups allows people to search old discussion threads.

Bitching and moaning might get you somewhere in the world of commercial software, but it most definitely won't in the world of open source. Next time be more humble.

aslakhellesoy on 25 Sep 2014

Could we close this, please? It makes me sad.

grahamlyons on 29 Jan 2015

Me too @grahamlyons! @stormcoder I'd love you to help us fix the docs. Feedback from new users is really important to us.

Are you willing to make a list of concrete actions we could take to improve the situation for you?

mattwynne on 29 Jan 2015

@grahamlyons Are you sad about the bickering in this ticket, or the poor state of the docs? I'd like to keep this ticket open until we actually have some decent docs for cucumber-clojure.

aslakhellesoy on 29 Jan 2015

@aslakhellesoy it's the tone of the ticket - I'd love to see more extensive documentation but perhaps we could start afresh, in a more positive light?

grahamlyons on 2 Feb 2015

The tone is water under the bridge for me at least. What would be great is to simply document how cucumber-clojure works in the cucumber-clojure README.md. I don't have time to spend on this (and I'm not a Clojure expert), but I'm happy to merge PRs.

When the new website starts to take shape we can move it there.

aslakhellesoy on 2 Feb 2015

I have a question with regards to cucumber test automation in bamboo. Does anyone have any recommended approaches where cucumber tests can be automated for projects in bamboo using a config file? (yaml file maybe?) any help would be greatly appreciated!