Add VS Code Snippets #96
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for VS Code snippets to help developers quickly generate common code patterns in the PICKL test automation framework. The snippets include templates for page objects, step definitions, feature files, and Gherkin scenarios.
Key Changes:
- Added VS Code snippets documentation to CONTRIBUTING.md explaining available snippets and usage
- Created
.vscode/pickl.code-snippetsfile with four snippet templates for common development patterns - Added subproject commit reference
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/CONTRIBUTING.md | Added comprehensive documentation section explaining available VS Code snippets, usage instructions, and contribution guidelines |
| .vscode/pickl.code-snippets | Created new snippets file containing four code templates for page objects, step definitions, feature files, and Gherkin scenarios |
| PICKL | Added subproject commit reference |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| " // implement action", | ||
| " }", | ||
| "}", | ||
| ], |
There was a problem hiding this comment.
The array on line 18 has a trailing comma. While JSON technically doesn't allow trailing commas, VS Code snippet files use JSON5 format which permits them. However, for consistency with the rest of the file where other arrays (lines 41, 54, 66) don't have trailing commas, this trailing comma should be removed.
| ], | |
| ] |
|
Good start, @italotlopes! I have a few high-level comments:
|
| "prefix": "feature-file", | ||
| "body": [ | ||
| "Feature: ${1:Feature description}", | ||
| "", |
There was a problem hiding this comment.
You could add the Background clause here. It's usually a precondition common for all of the scenarios in the feature file. It's not mandatory, but I think it would be a good addition here.
| "PICKL Feature File": { | ||
| "prefix": "feature-file", | ||
| "body": [ | ||
| "Feature: ${1:Feature description}", |
There was a problem hiding this comment.
Missing User Story below i.e. As a ... I want to ... So that ...
| "PICKL Gherkin Scenario": { | ||
| "scope": "gherkin", | ||
| "prefix": "gherkin-scenario", | ||
| "body": [ |
There was a problem hiding this comment.
Add the tag in the body, i.e. "@${1:tag}" right above Scenario
| "prefix": "gherkin-scenario", | ||
| "body": [ | ||
| " Scenario: ${1:Scenario description}", | ||
| " Given ${2:some precondition}", |
There was a problem hiding this comment.
I feel like instead of static Given, When, Then, the steps could be ${3|Given,When,Then,And,But|} ${4:step description} because it could be any of those at any level of the scenario, right? Just to be more flexible. Three of these steps would be a good number
| @@ -0,0 +1,69 @@ | |||
| { | |||
There was a problem hiding this comment.
A Given Step, When Step and Then Step template might be good additions as well
|
Hi @jedau, how are you? Thanks for you return. I will be studying and understanding the points you raised, in order to apply a better PR strategy in the future. |
2 participants
📋 Description
This PR adds documentation to the CONTRIBUTING guide explaining the available VS Code snippets and how to use and extend them.
🔗 Related Issue
Fixes #39
🎯 Type of Change
🧪 Testing
📸 Screenshots (if applicable)
✅ Checklist
📝 Additional Notes
This documentation was added to complete the acceptance criteria for the VS Code snippets feature.
🔍 Reviewer Notes
Please review the clarity and placement of the new VS Code snippets documentation.
Before submitting this PR, please ensure: