Skip to content

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

NicolasMassart
Copy link
Contributor

@NicolasMassart NicolasMassart commented Jan 28, 2025

Description

This PR is a suggestion to replace bullet points list by a Gherkin syntax code block for the PR template test section.

Pros

  • This really looks like a Cucumber scenario
  • Dev and QA would then speak the same language
  • It allows to refer to Gherkin syntax as a guideline and framework
  • Easy, or at least not more complicated to write

Cons

  • none as you can still write the bullet point if you want, it's just a template suggestion.
  • I'm curious to see what you think about this. Let me know in the PR.

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:


  1. Go to this page...

After

This is how the Manual testing steps template would look if we use Gherkin syntax:


Feature: my feature name
  Scenario: user [verb for user action]
    Given [describe expected initial app state] 
    When user [verb for user action]
    Then [describe expected outcome]

Pre-merge author checklist

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

@NicolasMassart NicolasMassart requested a review from a team as a code owner January 28, 2025 15:10
@NicolasMassart NicolasMassart self-assigned this Jan 28, 2025
@NicolasMassart NicolasMassart added the team-mobile-platform Mobile Platform team label Jan 28, 2025
Copy link
Contributor

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.

@NicolasMassart NicolasMassart added No QA Needed Apply this label when your PR does not need any QA effort. needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) labels Jan 28, 2025
@NicolasMassart NicolasMassart added Code Impact - Low Minor code change that can safely applied to the codebase skip-sonar-cloud Only used for bypassing sonar cloud when failures are not relevant to the changes. area-qa Relating to QA work (Quality Assurance) labels Feb 6, 2025
Copy link

sonarqubecloud bot commented Feb 7, 2025

@NicolasMassart NicolasMassart requested a review from Copilot March 6, 2025 18:32
Copy link
Contributor

@Copilot Copilot AI left a 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-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.22%. Comparing base (b539406) to head (31b3ff8).
Report is 21 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

sonarqubecloud bot commented Apr 1, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-qa Relating to QA work (Quality Assurance) Code Impact - Low Minor code change that can safely applied to the codebase needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) No QA Needed Apply this label when your PR does not need any QA effort. skip-sonar-cloud Only used for bypassing sonar cloud when failures are not relevant to the changes. team-mobile-platform Mobile Platform team
Projects
Status: Needs dev review
Development

Successfully merging this pull request may close these issues.

2 participants