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

README: update ast diagram to v6 using Mermaid class diagram #215

Merged
merged 4 commits into from
Mar 14, 2024

Conversation

binhtran432k
Copy link
Member

@binhtran432k binhtran432k commented Jan 16, 2024

🤔 What's changed?

  • Update the AST diagram in README using mermaid class diagram

⚡️ What's your motivation?

🏷️ 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?

GitHub supports Mermaid diagrams directly within Markdown using Markdown-like syntax, which is very helpful for future changes.

📋 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.

Update the AST diagram in README using mermaid class diagram
Copy link
Contributor

@mpkorstanje mpkorstanje left a comment

Choose a reason for hiding this comment

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

Cheers! Looks good. Apologies for the late review.

Would you be interested in replacing the other images with Mermaid diagrams as well?

@mpkorstanje mpkorstanje merged commit 8f8f33b into main Mar 14, 2024
1 check passed
@mpkorstanje mpkorstanje deleted the docs/ast branch March 14, 2024 18:26
jdeniau added a commit to mapado/prettier-plugin-gherkin that referenced this pull request Jul 25, 2024
cucumber/gherkin#215 did change the ast png file to a mermaid script
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.

README: Gherkin grammar diagram (AST) is missing Gherkin v6 changes (Rules, ...)
2 participants