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

EPIC: 3.x roadmap #134

Open
6 tasks
AlexSkrypnyk opened this issue Sep 13, 2023 · 1 comment
Open
6 tasks

EPIC: 3.x roadmap #134

AlexSkrypnyk opened this issue Sep 13, 2023 · 1 comment
Assignees

Comments

@AlexSkrypnyk
Copy link
Member

AlexSkrypnyk commented Sep 13, 2023

@AlexSkrypnyk
Copy link
Member Author

AlexSkrypnyk commented Oct 25, 2024

Steps reconciliation spreadsheet:
https://docs.google.com/spreadsheets/d/11zTWgbRdTIMaXBkwli9qiZINqxxBDuKq9BhpT9iPBok/edit?usp=sharing

Add the following rules to the README.md:

  • All types:

    • Avoid regexes in step definition comments. Use tuple format instead. It is easier to understand and maintain.
    • Use the following for tabled content.
    • Anything identified by a property should use with: Then the link :link with the title :title should exist
    • Use clear placeholder names to help the users to understand the expected value faster: content_type, not type
    • Do not use optional words like "(the|a)" and instead provide a single form. This helps with consistency.
    • Avoid on the page suffix - we are already on the page
  • Given - states tests pre-requisites, something that should be created to be present before the test runs

    • Use exists, have
    • Do not use should or should not (these are used in assertions)
    • Avoid using I (these are for actions)
  • When - defines an action, so should contain an action verb

    • Use I <verb>
  • Then - asserts expectations

    • Use should and should not to clearly state that this is an assertion
    • Start with a "thing" you are asserting for: Then the link with a title :title exists
    • Do not use I

@AlexSkrypnyk AlexSkrypnyk self-assigned this Oct 25, 2024
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

No branches or pull requests

1 participant