Add deprecated text to README#20
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @acronhub, 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 introduces a significant update to the README.md file by adding a clear deprecation notice. The primary purpose is to inform users that this repository is no longer recommended for use and to guide them towards an actively maintained alternative, qiita-marker. This change ensures that users are aware of the project's status and are directed to the correct resource.
Highlights
- Repository Deprecation Notice: A prominent deprecation warning has been added to the
README.mdfile, clearly indicating that the repository is no longer actively maintained. - Alternative Project Recommendation: The deprecation notice includes a direct recommendation and link to
qiita-markeras the preferred alternative for users.
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 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
-
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. ↩
There was a problem hiding this comment.
Pull Request Overview
This PR adds a deprecation notice to the README, informing users that the repository is no longer maintained and directing them to use qiita-marker as an alternative.
- Adds a deprecation warning at the top of the README
- Includes a link to the recommended replacement repository (qiita-marker)
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Code Review
This pull request adds a deprecation notice to the README.md file. The change is a good initiative. I've provided one suggestion to rephrase the notice for better clarity and conciseness, which will help prevent potential confusion for users reading the documentation.
| Note that this repository is now deprecated. | ||
| Please use the [qiita-marker](https://github.com/increments/qiita_marker). |
There was a problem hiding this comment.
This deprecation notice is a great addition. For improved clarity and to avoid potential confusion with the recommendation to use qiita-markdown later in the file (line 15), you could make this notice more direct by combining the two sentences.
| Note that this repository is now deprecated. | |
| Please use the [qiita-marker](https://github.com/increments/qiita_marker). | |
| This repository is deprecated. We recommend using [qiita-marker](https://github.com/increments/qiita_marker) instead. |
|
CI is not completing due to Ubuntu 18.04 being deprecated and no longer supported. Since this repository is being archived, I decided not to wait for the CI completion. |
cef8909 to
824e9da
Compare
What