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

Improvements to bug reporting experience #43

Open
5 tasks
tranhl opened this issue Nov 27, 2024 · 1 comment
Open
5 tasks

Improvements to bug reporting experience #43

tranhl opened this issue Nov 27, 2024 · 1 comment

Comments

@tranhl
Copy link
Collaborator

tranhl commented Nov 27, 2024

I'm seeing a couple of pain points come up for both users and maintainers when creating & triaging bug reports:

  • No clear process/guidance on how to best report a bug
  • It's unclear where diagnostics can be obtained
  • Diagnostics may contain sensitive user/company data

Actions we can take to address these problems:

  • Refactor action inputs logging into a single diagnostic report
  • Implement log anonymization
  • Introduce issue template
  • Link to issue submission form above error logs to encourage error reporting
  • Print diagnostics directly above error logs for convenience
@tranhl
Copy link
Collaborator Author

tranhl commented Nov 27, 2024

In terms of anonymization, the primary concern is sensitive information in branch names being exposed. Fundamentally, we only need insight into the node/leaf structure of the branch graph to do debugging. A potential approach to anonymization could be to replace feature/perennial branch names with unique human-readable stubs (e.g. feat/sensitive-company-work -> grain-loss-require-rocky).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant