Update README to add precautions about installation #313
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a warning notice to the README about proper installation of the Qiita CLI package. The warning clarifies that the official npm package name is @qiita/qiita-cli and cautions users to verify they are installing the correct package to avoid installing different packages with similar names.
- Adds a prominent warning callout in the installation section
- Clarifies the official npm package name for Qiita CLI
- Prevents users from accidentally installing incorrect packages
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @zumi0, 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!
このプルリクエストは、READMEファイルに重要な警告を追加することで、ユーザーがQiita CLIをインストールする際に誤ったnpmパッケージをインストールしてしまうリスクを軽減することを目的としています。これにより、ユーザーは正しいパッケージ名である「@qiita/qiita-cli」を確実に使用できるようになります。
Highlights
- READMEの更新: Qiita CLIのインストール手順に、公式のnpmパッケージ名に関する警告文を追加しました。
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| 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 pull request 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. ↩
| > Qiita公式で提供している Qiita CLI の npm package 名は **@qiita/qiita-cli** となります。 | ||
| > その他は異なるパッケージがインストールされてしまいます。必ずご確認の上、インストールしてください。 |
There was a problem hiding this comment.
警告メッセージの表現をより明確にすることで、ユーザーが誤ったパッケージをインストールするリスクをさらに低減できるかと思います。
現在の「その他は異なるパッケージがインストールされてしまいます。」という表現も正しいですが、より具体的に「類似した名前の非公式なパッケージ」の存在に言及することで、注意喚起の効果が高まります。
| > Qiita公式で提供している Qiita CLI の npm package 名は **@qiita/qiita-cli** となります。 | |
| > その他は異なるパッケージがインストールされてしまいます。必ずご確認の上、インストールしてください。 | |
| > Qiita公式で提供している Qiita CLI の npm package 名は **@qiita/qiita-cli** です。 | |
| > 類似した名前の非公式なパッケージをインストールしないよう、必ずパッケージ名をご確認ください。 |
What
README に、インストールする際の注意事項を追加しました。
内容は、以下のように表示されます。
Warning
Qiita公式で提供している Qiita CLI の npm package 名は @qiita/qiita-cli となります。
その他は異なるパッケージがインストールされてしまいます。必ずご確認の上、インストールしてください。
How
Why
Refs