Search:
Development Setup 5 Software Development 5 GitHub 3 Scrum 1 Python Projects 2 Getting Started 1

We use the GitHub Issues tracking system for bug reporting and feature requests. If something doesn’t behave as expected when you’re using our software, you should report it by creating a new issue on that project’s GitHub page.

This article provides an excellent introduction to the Issue tracker on GitHub. We really like the Adobe Brackets guide for bug reporting, here. To steal from their guide, each bug report should include the following:

  • Descriptive title - use keywords so others can find your bug (avoiding duplicates)
  • Steps to trigger the problem that are specific, and repeatable
  • What happens when you follow the steps, and what you expected to happen instead.
  • Include the exact text of any error messages if applicable (or upload screenshots).
  • Software version (or if you’re pulling directly from Git, your current commit SHA - use git rev-parse HEAD)
  • Did this work in a previous version? If so, also provide the version that it worked in.