-
Notifications
You must be signed in to change notification settings - Fork 32
Fix typo in snyk_rules_smart_apply.md #674
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
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Summary of ChangesHello @jeffsnyk, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on a small but important refinement to the project's documentation. By fixing a grammatical error, it ensures that the instructions for applying Snyk rules are clear and professional, contributing to better understanding and adherence to security scanning guidelines. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request correctly fixes a typo in the snyk_rules_smart_apply.md documentation file. The change is valid. I have added one suggestion on the modified line to further improve the document's formatting and consistency. Otherwise, the change looks good.
|
|
||
| - BEFORE declaring task complete: Run snyk_code_scan tool when a significant change has been made in first party code. | ||
| - This shoule only apply for Snyk-supported coding language | ||
| - This should only apply for Snyk-supported coding language |
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.
Thanks for fixing the typo. To further improve this line for clarity and consistency, I have a couple of suggestions:
- Improve Structure: This line is a clarification for the preceding point. Indenting it will render it as a sub-bullet, which improves the document's structure and makes the relationship between the points clearer.
- Improve Consistency: The term 'coding language' is a bit redundant. For consistency with other documentation (e.g.,
snyk_rules_always_apply.md), this could be simplified to 'a Snyk-supported language'.
My code suggestion below incorporates both of these improvements.
| - This should only apply for Snyk-supported coding language | |
| - This should only apply for a Snyk-supported language |
Description
Provide description of this PR and changes, if linked Jira ticket doesn't cover it in full.
Checklist
Screenshots / GIFs
Visuals that may help the reviewer. Please add screenshots for any UI change. GIFs are most welcome!