Rename contributing guidelines to style guide #16682
Conversation
Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
Summary of ChangesHello @leecalcote, 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 minor documentation update, specifically renaming the title of the Meshery CLI contributing guidelines page to "Meshery CLI Style Guide". This change aims to provide a more accurate and descriptive title for the document, better reflecting its content which pertains to design principles and code conventions rather than general contribution steps. 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.
Code Review
This pull request updates the title of the CLI contributing guidelines to 'Style Guide'. While this change accurately reflects the content's purpose, the change appears incomplete. The filename contributing-guidelines.md has not been updated to match the new title, which can cause confusion. I've added a comment with a suggestion to rename the file for consistency. Additionally, please ensure your commits are signed as per the contribution guidelines.
| --- | ||
| layout: default | ||
| title: "Meshery CLI Contributing Guidelines" | ||
| title: "Meshery CLI Style Guide" |
There was a problem hiding this comment.
While changing the title to 'Meshery CLI Style Guide' is a good step, this change seems incomplete given the PR title 'Rename contributing guidelines to style guide'. The file itself has not been renamed and is still contributing-guidelines.md. For consistency and to avoid confusion, please consider renaming the file as well (e.g., to cli-style-guide.md). This would likely also require updating the permalink on line 5 and any internal links pointing to this page.
|
|
|
🚀 Preview for commit 730f4cc at: https://694337799e4b15cc08606a9f--meshery-docs-preview.netlify.app |
Notes for Reviewers
Signed commits