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

Report a bug #397

Merged
merged 21 commits into from
Oct 22, 2023
Merged

Report a bug #397

merged 21 commits into from
Oct 22, 2023

Conversation

jacoblurie29
Copy link
Collaborator

@jacoblurie29 jacoblurie29 commented Oct 12, 2023

Bug Reporting

Users can now report bugs to us at VandyHacks! How does this work?

  1. Users will navigate through their dashboard to /report
  2. There they can enter a description of what the bug they found is
  3. On sending the report, a report documented is generated in mongo containing the name, email, role, time, date, and description of the bug
  4. After the document is created, a call to the GitHub API is made, creating an issue in the witness GitHub repository
  5. The issue contains the role of the user and the description of the bug
  6. The bug is assigned to whoever is the "on call developer" in the settings page of the organizer dashboard
  7. The organizer dashboard now contains a new tab that has all of the reported bugs and their information
  8. The dashboard table also integrates with the GitHub API to show the live status (open or closed) of the GitHub issue associated with the reported bug
  9. The table also includes clickable links to redirect in a new tab to the GitHub issue page for that bug
  10. The /report page also includes a similar table for users to see the status of the bugs they have reported
  11. Added a button bottom right corner of Hacker and Judge dashboard to redirect to /report page

Report page

image

Reports Tab (Organizer)

image

@jacoblurie29 jacoblurie29 self-assigned this Oct 12, 2023
@vercel
Copy link

vercel bot commented Oct 12, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
witness ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 22, 2023 2:25am

@jacoblurie29 jacoblurie29 marked this pull request as draft October 12, 2023 04:04
@socket-security
Copy link

New dependencies detected. Learn more about Socket for GitHub ↗︎

Packages Version New capabilities Transitives Size Publisher
octokit 2.1.0 eval, network, shell, environment +58 10.3 MB octokitbot

pages/api/report.ts Fixed Show fixed Hide fixed
pages/api/report.ts Fixed Show fixed Hide fixed
pages/api/report.ts Fixed Show fixed Hide fixed
pages/api/report.ts Fixed Show fixed Hide fixed
pages/api/report.ts Fixed Show fixed Hide fixed
Copy link
Member

@zineanteoh zineanteoh left a comment

Choose a reason for hiding this comment

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

Hands down coolest feature we're adding to witness this year

types/client.ts Show resolved Hide resolved
pages/api/report.ts Show resolved Hide resolved
pages/api/report.ts Outdated Show resolved Hide resolved
pages/api/report.ts Show resolved Hide resolved
pages/report.tsx Outdated Show resolved Hide resolved
@zineanteoh
Copy link
Member

@jacoblurie29 PR #409 has been opened awaiting your review

@zineanteoh
Copy link
Member

#409 merged ✅
Happy to review again after the button has been added on HackerDash and JudgeDash and comments above addressed 👍

Copy link
Member

@zineanteoh zineanteoh left a comment

Choose a reason for hiding this comment

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

Final changes, then we're good to merge 👍

pages/report.tsx Outdated Show resolved Hide resolved
pages/api/report.ts Outdated Show resolved Hide resolved
pages/api/report.ts Outdated Show resolved Hide resolved
pages/api/report.ts Outdated Show resolved Hide resolved
pages/report.tsx Show resolved Hide resolved
pages/report.tsx Outdated Show resolved Hide resolved
pages/report.tsx Outdated Show resolved Hide resolved
pages/report.tsx Show resolved Hide resolved
Copy link
Member

@zineanteoh zineanteoh left a comment

Choose a reason for hiding this comment

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

Let’s Get This…

@zineanteoh zineanteoh merged commit 7e92e22 into main Oct 22, 2023
5 checks passed
@zineanteoh zineanteoh deleted the report-a-bug branch October 22, 2023 02:58
gabrield2731 pushed a commit that referenced this pull request Oct 26, 2023
* Report page, report organizer page, model and api for reports

* GitHub api integration

* Issues are completed, descriptions are formatted, users are redirected after submitting, links to github

* Added to env template

* Code security

* Users can view their own reports from the report screen

* Issues now set to track github api request

* Remove import

* Fixed code scan issue

* Remove unnecessary code

* Title for settings

* remove unused css class

* Changes from review, report a bug buttons, and theme added to Judge Dash

* Judge theme loads on render of dashboard

* Remove console logs, add comments, change hacker to judge in some places

* Added loading indicator for GH issues and now show a deleted tag for issues that aren't found from query

* Requested changes and visual updates to report screen

---------

Co-authored-by: Zi Nean Teoh <[email protected]>
Co-authored-by: Zi Nean Teoh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants