Skip to content

Update bug report template #133

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

Update bug report template #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1892295
Add rust version and commit hash to bug report
mdevino Jul 25, 2024
e67a457
Add script to collect environment details for bug reports
mdevino Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,17 @@ A clear and concise description of what the bug is.

## Platform

Please provide details about the environment you are using, including the following:
Please provide details about the environment you are using (run `scripts/collect_env.sh`).

Hint: In case you cannot run script due to permissions, try `chmod u+x scripts/collect_env.sh`, then run again.

<!--
Example output:

rustc 1.78.0 (9b00956e5 2024-04-29)
Commit hash: 1892295
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will likely cover the case of local users/devs and potentially users accessing orchestrator through an image that indicates / maps to commit hash. Eventually as orchestrator is maintained, I would expect there to be potentially semver crate versions that users could reference

-->

- Interpreter version:
- Library version:

## Sample Code

Expand Down
4 changes: 4 additions & 0 deletions scripts/collect_env.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#/usr/bin/env sh

rustc --version
echo "Commit hash: $(git log -1 --pretty=format:'%h')"