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

add short explanation how it works to README.md #291

Merged
merged 1 commit into from
Mar 4, 2024

Conversation

erichstuder
Copy link
Contributor

Summary

I found a short but very informative explanation on how it works.
This helped me a lot as a newbie.

About the questions at the end:
It is NOT my own work. And it is copied from Stack Overflow.
I think as I have added a link to the source and the author it could be acceptable.

Anyway, it would be great to have an explanation like this in the README.md.

Details

Add a chapter to README.md that explains how it works.

Motivation and Context

Faster understanding of the tool.

How Has This Been Tested?

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).

Checklist:

  • [ NO ] It is my own work, its copyright is implicitly assigned to the project and no substantial part of it has been copied from other sources (including Stack Overflow). In rare occasions this is acceptable, like in CMake modules where the original copyright information should be kept.
  • I'm using the same code standards as the existing code (indentation, spacing, variable naming, ...).
  • [n/a] I've added tests for my code.
  • [n/a] I have verified whether my change requires changes to the documentation
  • My change either requires no documentation change or I've updated the documentation accordingly.
  • [n/a, only one commit] My branch has been rebased to main, keeping only relevant commits.

Copy link
Contributor

@ursfassler ursfassler left a comment

Choose a reason for hiding this comment

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

Thanks for contributing. It looks like a good addition.
I am not sure bout the licensing as stack-overflow is CC BY-SA 4.0 and we have a MIT license. On the other hand, it is not in the production code.

Is it possible to have the author of the text hand in the PR?
Or otherwise only add a link?

@luke-hill
Copy link
Contributor

@paoloambrosio used to be a maintainer here so I wouldn't worry about it too much

@ursfassler ursfassler merged commit 7583400 into cucumber:main Mar 4, 2024
7 checks passed
@aslakhellesoy
Copy link
Contributor

Hi @erichstuder,

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

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.

4 participants