[Doc] Auto sign-off for VSCode #20132
Conversation
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
There was a problem hiding this comment.
Summary of Changes
Hello @DarkLight1337, 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 enhances the project's contributing documentation by adding clear instructions for VSCode users on how to automatically sign off their Git commits. This update aims to simplify the contribution process and ensure compliance with sign-off requirements for a broader range of development environments.
Highlights
- Documentation Enhancement: Expanded the
contributingguide to include instructions for enabling automatic Git commit sign-off within VSCode. - IDE Support: Updated the tip section to provide a more structured and comprehensive guide for automatic sign-off across multiple IDEs (PyCharm and VSCode).
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and 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 to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
| You can enable automatic sign-off via your IDE: | ||
|
|
||
| - **PyCharm**: Click on the `Show Commit Options` icon to the right of the `Commit and Push...` button in the `Commit` window. | ||
| It will bring up a `git` window where you can modify the `Author` and enable `Sign-off commit`. | ||
| - **VSCode**: Open the [Settings editor](https://code.visualstudio.com/docs/configure/settings) | ||
| and enable the `Git: Always Sign Off` (`git.alwaysSignOff`) field. |
There was a problem hiding this comment.
It would be helpful to include a link to the VSCode settings editor to make it easier for users to find the setting.
| You can enable automatic sign-off via your IDE: | |
| - **PyCharm**: Click on the `Show Commit Options` icon to the right of the `Commit and Push...` button in the `Commit` window. | |
| It will bring up a `git` window where you can modify the `Author` and enable `Sign-off commit`. | |
| - **VSCode**: Open the [Settings editor](https://code.visualstudio.com/docs/configure/settings) | |
| and enable the `Git: Always Sign Off` (`git.alwaysSignOff`) field. | |
| - **PyCharm**: Click on the `Show Commit Options` icon to the right of the `Commit and Push...` button in the `Commit` window. | |
| It will bring up a `git` window where you can modify the `Author` and enable `Sign-off commit`. | |
| - **VSCode**: Open the [Settings editor](https://code.visualstudio.com/docs/configure/settings/user) and enable the `Git: Always Sign Off` (`git.alwaysSignOff`) field. |
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> Signed-off-by: Will Eaton <weaton@redhat.com>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> Signed-off-by: avigny <47987522+avigny@users.noreply.github.com>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.Purpose
Follow-up to #20120
Test Plan
Test Result
(Optional) Documentation Update