-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
chore: suggest gherkin syntax for test description #13227
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
base: main
Are you sure you want to change the base?
Conversation
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
|
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.
PR Overview
This PR updates the PR template to suggest using a Gherkin syntax code block for the manual testing steps section instead of the traditional bullet points.
- Replaces the bullet list with a Gherkin feature scenario example.
- Provides a clear example to align communication between dev and QA teams.
Reviewed Changes
File | Description |
---|---|
.github/pull-request-template.md | Updated the Manual testing steps section with Gherkin syntax |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #13227 +/- ##
==========================================
+ Coverage 65.72% 66.22% +0.49%
==========================================
Files 2228 2243 +15
Lines 47433 47934 +501
Branches 6682 6756 +74
==========================================
+ Hits 31176 31742 +566
+ Misses 14263 14176 -87
- Partials 1994 2016 +22 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Description
This PR is a suggestion to replace bullet points list by a Gherkin syntax code block for the PR template test section.
Pros
Cons
Examples
Examples of PRs where I already use this instead of the bullet list (but it's not in the template):
Related issues
n/a
Manual testing steps
n/a
Screenshots/Recordings
Before
This is how the Manual testing steps template looks now:
After
This is how the Manual testing steps template would look if we use Gherkin syntax:
Pre-merge author checklist
Pre-merge reviewer checklist