How to Report an Issue
Purpose
This guide explains how to identify, verify, and document bugs or unexpected behaviors in Chambey systems by creating high-quality GitHub issues.
Summary
High-quality bug reports help developers fix issues faster. When reporting an issue, include a clear summary, step-by-step instructions to reproduce the bug, expected vs. actual behaviors, screenshots (if applicable), and diagnostic logs.
Who This Is For
- Ecosystem Users & Learners: Finding issues in courseware or dashboards.
- QA Testers & Developers: Debugging integrations on staging environments.
Key Details
- Search First: Check the GitHub Issue tracker to confirm the issue hasn't already been reported.
- Use the Bug Template: Always populate all fields in the default issue template.
- State Environment Info: Note your OS, browser, and package versions (e.g., node, npm).
Next Steps
- Open the relevant repository's issue tracker on GitHub and click "New Issue".
- Review the How to Suggest a Feature guide if your issue is a enhancement idea rather than a bug.