Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Book Features and Test Modules Organization chapters (#55, #64, #102, #103, #123) #132

Merged
merged 8 commits into from
Sep 30, 2021

Conversation

ilslv
Copy link
Member

@ilslv ilslv commented Sep 28, 2021

Resolves #55, #64, #102, #103, #123

Synopsis

New features can be tricky to find, especially at the beginning.

Solution

Add Features and Test Modules Organisation chapters to the book.

Checklist

  • Created PR:
    • In draft mode
    • Name contains Draft: prefix
    • Name contains issue reference
    • Has assignee
  • Documentation is updated (if required)
  • Tests are updated (if required)
  • Changes conform code style
  • CHANGELOG entry is added (if required)
  • FCM (final commit message) is posted
    • and approved
  • Review is completed and changes are approved
  • Before merge:
    • Milestone is set
    • PR's name and description are correct and up-to-date
    • Draft: prefix is removed
    • All temporary labels are removed

@ilslv ilslv added the k::documentation Related to project documentation label Sep 28, 2021
@ilslv ilslv added this to the 0.10 milestone Sep 28, 2021
@ilslv ilslv self-assigned this Sep 28, 2021
@ilslv
Copy link
Member Author

ilslv commented Sep 29, 2021

FCM

Add "Features" and "Test Modules Organization" chapters to the Book (#55, #64, #102, #103, #123, #132)

Additionally:
- fix outputing English in writer::Basic instead of parsed keywords

@ilslv ilslv requested a review from tyranron September 29, 2021 06:34
@ilslv ilslv changed the title Draft: Book Features chapter (#55, #64, #102, #103, #123) Draft: Book Features and Test Modules Organization chapters (#55, #64, #102, #103, #123) Sep 29, 2021
Copy link
Member

@tyranron tyranron left a comment

Choose a reason for hiding this comment

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

@ilslv some more clear code examples are required, anything else seems to be OK.

As your test suit grows, it may become harder to notice how minimal changes to `regex`es can lead to mismatched `Step`s. To avoid this, we recommend using [`Cucumber::fail_on_skipped()`](https://docs.rs/cucumber/*/cucumber/struct.Cucumber.html#method.fail_on_skipped) combining with `@allow_skipped` tag. This will allow you to mark out `Scenario`s which `Step`s are allowed to skip.

And, as time goes on, total run time of all tests can become overwhelming when you only want to test small subset of `Scenario`s. At least until you discover [`Cucumber::filter_run_and_exit()`](https://docs.rs/cucumber/*/cucumber/struct.Cucumber.html#method.filter_run_and_exit), which will allow you run only `Scenario`s marked with custom [tags](https://cucumber.io/docs/cucumber/api/#tags).
Copy link
Member

Choose a reason for hiding this comment

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

This case and the above requires code examples. It hard to grasp the thing without them. Please, add the code examples directly to rate docs, so the provided links will lead there.

@tyranron tyranron changed the title Draft: Book Features and Test Modules Organization chapters (#55, #64, #102, #103, #123) Book Features and Test Modules Organization chapters (#55, #64, #102, #103, #123) Sep 29, 2021
@tyranron tyranron marked this pull request as ready for review September 29, 2021 11:56
@ilslv ilslv requested a review from tyranron September 30, 2021 06:45
@tyranron tyranron merged commit 2313010 into main Sep 30, 2021
@tyranron tyranron deleted the book-features-chapter branch September 30, 2021 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
k::documentation Related to project documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Please clarify: type of table cells
2 participants