Report an Issue
Thank you for using RuyiSDK. If you run into a problem, find a bug, have a feature suggestion, or would like RuyiSDK to support a new package, you are welcome to open an issue or post on the forum.
Where should I submit an issue?
Different parts of RuyiSDK are hosted in different GitHub repositories. Please choose the appropriate repository based on the type of issue:
| Issue type | View all issues | Open a new issue |
|---|---|---|
| Problems with the Ruyi package manager itself, such as unexpected CLI behavior, installation failures, virtual environments, device flashing, and similar issues | View issues | Open an issue |
| Broken package links, outdated package versions, or requests for new packages | View issues | Open an issue |
| Issues related to the RuyiSDK Eclipse plugins | View issues | Open an issue |
| Issues related to the RuyiSDK VS Code extension | View issues | Open an issue |
| Frontend issues on ruyisdk.org | View issues | Open an issue |
| Backend issues for api.ruyisdk.cn | View issues | Open an issue |
Before opening a new issue, please search to see whether the same or a similar problem has already been reported. If the exact issue already exists, you can add your environment details, reproduction steps, or any other useful clues there. If your case is only similar, it still helps to mention related existing issues in your new report so developers can connect them during investigation.
What information should I include in an issue?
To help developers understand and diagnose the problem more quickly, please provide as much of the following information as possible:
-
Environment details
Include the software version, operating system version, hardware platform, and any other relevant environment details.
If the issue is related to the Eclipse or VS Code plugins, please also include the IDE version.
Do not post sensitive information such as account credentials, passwords, access tokens, or private addresses. -
Problem description
Explain what happened, what you expected to happen, and what actually happened instead.
If you have error messages, screenshots, or logs, include them as well. -
Steps to reproduce
Describe the conditions under which the issue occurs.
If possible, provide a minimal and reliably reproducible sequence of steps.
What if I do not have a GitHub account?
If you do not have a GitHub account, or opening an issue there is inconvenient, you can also post on the RuyiSDK forum at ruyisdk.cn. The developers and other users will still do their best to help diagnose and resolve the problem.