Skip to content

Add readme to cucumber-junit #1306

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Merged
merged 2 commits into from
Dec 28, 2017
Merged

Add readme to cucumber-junit #1306

merged 2 commits into from
Dec 28, 2017

Conversation

mpkorstanje
Copy link
Contributor

Summary

Add readme to cucumber-junit

@mpkorstanje mpkorstanje added JUnit 📖 documentation Improvements or additions to documentation labels Dec 23, 2017
@mpkorstanje mpkorstanje force-pushed the add-readme-for-cucumber-junit branch from 47e93d4 to 2a7ad08 Compare December 23, 2017 20:36
@coveralls
Copy link

Coverage Status

Coverage remained the same at 81.473% when pulling 2a7ad08 on add-readme-for-cucumber-junit into 3ea236b on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 81.473% when pulling 2a7ad08 on add-readme-for-cucumber-junit into 3ea236b on master.

haroon-sheikh
haroon-sheikh approved these changes Dec 26, 2017
View reviewed changes
Copy link
Contributor

@haroon-sheikh haroon-sheikh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

mlvandijk
mlvandijk reviewed Dec 27, 2017
View reviewed changes
Copy link
Member

@mlvandijk mlvandijk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really great addition!! Some minor suggestions to clarify further

junit/README.md Outdated
}
```

This will execute all scenarios in the package of the runner. By default glue code is assumed to be in the same
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[text edit suggestion] "This will execute all scenarios in the same package as the runner; by default glue code is assumed to be in the same package."

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[suggestion] Add an example of how to use the '@CucumberOptions'?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have some documentation about cucumber options to link here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not atm. Fyi, it's just a suggestion. Not blocking at all.

junit/README.md Outdated

## Using JUnit Rules ##

Cucumber supports JUnits `@ClassRule`, `@BeforeClass` and `@AfterClass` annotations. These will be invoked around the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph might not be clear Cucumber users who are not full-on software developers (yet).

Particularly:

"Cucumber supports JUnits @ClassRule, @BeforeClass and @AfterClass annotations. These will be invoked around the
+suite of features. " => what does it mean to run 'around the suite of features'? Is this like a BeforeAll/AfterAll?

"Using these is not recommended as it limits the portability between different runners. " => what is 'portability between different runners'? Why is limiting this a bad thing?

"Instead it is
+recommended to use Cucumbers Before and After hooks to setup scaffolding." => How to use 'Before' and 'After' hooks? What is 'setup scaffolding'?

Maybe this is not the place to answer all of these questions, but I think this could be clarified a little to be clearer to a wider audience.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have some documentation about the Before and After hooks? I am assuming people are familiar with cucumber when they read this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we do. Currently here: https://cucumber.netlify.com/hooks/

junit/src/main/java/cucumber/api/junit/Cucumber.java Outdated
@@ -48,7 +48,8 @@
* Additional hints can be given to Cucumber by annotating the class with {@link CucumberOptions}.
* <p>
* Cucumber also supports JUnits {@link ClassRule}, {@link BeforeClass} and {@link AfterClass} annotations.
* These will be invoked around the suite of features" and moved to the end of the java doc.
* These will be invoked around the suite of features. Using these is not recommended as it limits the portability
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above. If any changes are made based on those comments, please update accordingly also here.

@mpkorstanje mpkorstanje force-pushed the add-readme-for-cucumber-junit branch 3 times, most recently from eac6720 to fbf2b54 Compare December 27, 2017 15:00
@mpkorstanje mpkorstanje force-pushed the add-readme-for-cucumber-junit branch from fbf2b54 to ef167fe Compare December 27, 2017 15:02
@coveralls
Copy link

Coverage Status

Coverage remained the same at 81.473% when pulling fbf2b54 on add-readme-for-cucumber-junit into 3ea236b on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 81.473% when pulling ef167fe on add-readme-for-cucumber-junit into 3ea236b on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 81.473% when pulling ef167fe on add-readme-for-cucumber-junit into 3ea236b on master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 81.473% when pulling ef167fe on add-readme-for-cucumber-junit into 3ea236b on master.

mlvandijk
mlvandijk approved these changes Dec 27, 2017
View reviewed changes
Copy link
Member

@mlvandijk mlvandijk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Details can (and probably should) be clarified in documentation if needed.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 81.473% when pulling 2c2af9d on add-readme-for-cucumber-junit into 3ea236b on master.

@mpkorstanje mpkorstanje merged commit 179ba77 into master Dec 28, 2017
@mpkorstanje mpkorstanje deleted the add-readme-for-cucumber-junit branch December 28, 2017 15:14
@mlvandijk mlvandijk mentioned this pull request Jan 2, 2018
Merged
@lock
Copy link

lock bot commented Dec 28, 2018

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.

@lock lock bot locked as resolved and limited conversation to collaborators Dec 28, 2018
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Reviewers

@haroon-sheikh haroon-sheikh haroon-sheikh approved these changes

@mlvandijk mlvandijk mlvandijk approved these changes

Assignees
No one assigned
Labels
📖 documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mpkorstanje @coveralls @haroon-sheikh @mlvandijk