-
Notifications
You must be signed in to change notification settings - Fork 29
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 Gherkin Linting to Megalinter Workflow and Update Implementation #292
base: main
Are you sure you want to change the base?
Add Gherkin Linting to Megalinter Workflow and Update Implementation #292
Conversation
…Guidelines (#3) * Create .gherkin-lintrc * add gherkin lint in mega linter * Create Gherkin-linting-implementation-guideline * Update Gherkin-linting-implementation-guideline * Update Gherkin-linting-implementation-guideline * Delete documentation/Gherkin-linting-implementation-guideline * Update API-linting-Implementation-Guideline.md * Update API-linting-Implementation-Guideline.md * fine tune linting rules * customization of Indentation rule
Nice work @ravindrapalaskar17 ! For the Open Points for Discussion:
|
Thanks @ravindrapalaskar17! Regarding:
Within QualityOnDemand we have currently a mix of kebab-case and camelCase (following the formats of the components of the filename): cc: @jlurien |
This format is allowed in API Testing Guidelines |
This part is a configuration for the no-restricted-patterns rule, which is applied to various sections of Gherkin feature files. It helps restrict the use of certain terms or patterns in the description, feature, and background sections. |
Regarding Indentation:
Propose to change: Based on how currently Test inputs are provided
Other comments: Rest of current configuration proposal seems to work fine:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
What type of PR is this?
Close the issue: - #142
Add one of the following kinds:
enhancement/feature
Documentation\
What this PR does / why we need it:
This PR includes the addition of Gherkin linting in the Megalinter workflow to lint the test contribution feature files, along with implementation guideline documentation
Which issue(s) this PR fixes:
Fixes #142
Open Points for Discussion:
Standard Name Length:
The standard name length for features, steps, and scenarios was initially set to 70 characters. However, after testing all feature files, we have adjusted it to 90 for features, 190 for steps, and 190 for scenarios.
List of No-Restricted-Tags:
Review and finalize the list of tags that should be restricted or allowed.
Max-Scenarios-Per-File:
The standard is 15 scenarios per file, but we have increased this limit to 50 scenarios per file.
Keyword Logical Order:
Discuss the logical order of keywords (Given, When, Then, And) and ensure it is consistently enforced.
New Line at EOF:
Decide whether the rule for enforcing a new line at the end of files should be turned on or off.
No-Restricted-Patterns:
Identify and agree on a list of words or patterns that should be avoided in the Feature, Background, and Scenario sections.
File Name Format:
Decide on a standard file naming convention: PascalCase, Title Case, camelCase, kebab-case, or snake_case.
Indentation:
Finalize the indentation standards for Gherkin files (e.g., number of spaces or tabs to use).