docs: prefer go test to use of godog cli in README

danielhelfand commented 1 year ago

Closes #537

This pull request updates documentation to prefer go test over the godog CLI in the main README example. I realize there has been some discussion around deprecating the CLI since last checking on this, so please let me know if the deprecation information I was working off of from #478 is still accurate.

🤔 What's changed?

Remove godog CLI related details from main README example. Add notice of CLI deprecation to docs.

⚡️ What's your motivation?

If the CLI is to be deprecated or have less maintenance around it, adopters of godog should be pointed to up to date information when considering the project.

🏷️ What kind of change is this?

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

♻️ Anything particular you want feedback on?

📋 Checklist:

[x] 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.
[X] My change requires a change to the documentation.
- [X] I have updated the documentation accordingly.
[X] Users should know about my change
- [X] 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[bot] commented 1 year ago

Codecov Report

Merging #548 (684f65c) into main (17f07d2) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #548   +/-   ##
=======================================
  Coverage   82.24%   82.24%           
=======================================
  Files          27       27           
  Lines        3340     3340           
=======================================
  Hits         2747     2747           
  Misses        484      484           
  Partials      109      109

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

vearutop commented 1 year ago

Yes, deprecation info is still accurate, thank you for updating the docs! 👍

aslakhellesoy commented 1 year ago

Hi @danielhelfand,

Thanks for your making your first contribution to Cucumber, and welcome to the Cucumber committers team! You can now push directly to this repo and all other repos under the cucumber organization! 🍾

In return for this generous offer we hope you will:

✅ Continue to use branches and pull requests. When someone on the core team approves a pull request (yours or someone else's), you're welcome to merge it yourself.
💚 Commit to setting a good example by following and upholding our code of conduct in your interactions with other collaborators and users.
💬 Join the community Slack channel to meet the rest of the team and make yourself at home.
ℹ️ Don't feel obliged to help, just do what you can if you have the time and the energy.
🙋 Ask if you need anything. We're looking for feedback about how to make the project more welcoming, so please tell us!

On behalf of the Cucumber core team, Aslak Hellesøy Creator of Cucumber

cucumber / godog