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

Update README to reflect current best practices in creating and running tests #477

Merged
merged 3 commits into from
May 21, 2022

Conversation

vearutop
Copy link
Member

@vearutop vearutop commented May 20, 2022

Related to #472.

🤔 What's changed?

This PR updates README to

  • prioritize go test usage over CLI godog as it grants better flexibility and familiarity for Go developers,
  • use context.Context in step examples for better concurrency readiness.

⚡️ What's your motivation?

Running tests with CLI godog has limitations (#154) and is sometimes a bit obscure due to doing "magic" under the hood, using regular Go tests is (in my opinion) a better approach in general, so I think we should update documentation to encourage more go test usage.

🏷️ What kind of change is this?

  • 🏦 Refactoring/debt/DX (improvement to code design, tooling, documentation etc. without changing behaviour)

♻️ Anything particular you want feedback on?

📋 Checklist:

  • I agree to respect and uphold the Cucumber Community Code of Conduct
  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

This text was originally generated from a template, then edited by hand. You can modify the template here.

@codecov
Copy link

codecov bot commented May 20, 2022

Codecov Report

Merging #477 (44d44b8) into main (d52a4d3) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #477   +/-   ##
=======================================
  Coverage   81.42%   81.42%           
=======================================
  Files          27       27           
  Lines        2197     2197           
=======================================
  Hits         1789     1789           
  Misses        312      312           
  Partials       96       96           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d52a4d3...44d44b8. Read the comment docs.

@mattwynne
Copy link
Member

Looks good to me!

Copy link
Member

@mattwynne mattwynne left a comment

Choose a reason for hiding this comment

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

@vearutop vearutop merged commit 99655f7 into main May 21, 2022
@vearutop vearutop deleted the update-readme branch May 21, 2022 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants