Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Script Output for Helping Users #244

Closed
jekhokie opened this issue Mar 10, 2021 · 1 comment · Fixed by #246
Closed

Support Script Output for Helping Users #244

jekhokie opened this issue Mar 10, 2021 · 1 comment · Fixed by #246
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@jekhokie
Copy link
Owner

It would be helpful to have some auto-generated output that users can put into an issue or via Discord that could help maintainers of the framework troubleshoot faster and easier by getting information that is automatically output from the script. The idea would be, when a user has difficulties, they run the script (e.g. ./support.sh) and copy/paste the output to the Discord chat or in a new GitHub issue that will contain things such as:

  • Git commit hash of the local repository so we know how "up to date" the user is (git rev-parse HEAD)
  • OS architecture details (uname -a)
  • Whether there have been any changes to the local source-controlled files (git status - we probably only want to know if files have been changed, not necessarily what has changed, as this could accidentally expose sensitive info).
  • Maybe a way to get to SDR details via rtl_test output?

This scope should include updating the template .github/ISSUE_TEMPLATE/error.md to include instructions on running the script and pasting the output into the issue or in Discord.

@jekhokie jekhokie added enhancement New feature or request good first issue Good for newcomers labels Mar 10, 2021
@jekhokie jekhokie linked a pull request Mar 10, 2021 that will close this issue
@Krolykke
Copy link

Dang you are fast!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants