README: update ast diagram to v6 using Mermaid class diagram - Githubissues

cucumber / gherkin

A parser and compiler for the Gherkin language.

MIT License

160 stars 48 forks source link

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

Closed binhtran432k closed 3 months ago

binhtran432k commented 5 months ago

🤔 What's changed?

Update the AST diagram in README using mermaid class diagram

⚡️ What's your motivation?

Fixes #141

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

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

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