Skip to content

Reporting a bug

Jump to bottom
Francois Bedard edited this page Jan 26, 2018 · 2 revisions

Getting Help

This section provides guidelines for submitting questions, support requests and bug reports against ARC Development Systems. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating your report, please check this list as you might find out that you don't need to create one. When you are creating a report, please include as many details as possible and use the template provided for this purpose.

Before Submitting a Report

  • Check the documentation. You might be able to find the cause of the problem and fix things yourself.
  • Verify that you can reproduce the problem in the latest version of software and using latest supported tools.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue against your Development System in this repository and provide the following information.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining which release or commit of embARC OSP you are using, and how you use embARC OSP, e.g. which command exactly you used in the terminal. When listing steps, don't just say what you did, but explain how you did it. For example, if you run a command, explain which terminal you use and the directory where you run the command?
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out the exact problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can try to record the GIF of the steps to reproduce the bug. You can use licecap to record GIFs on macOS and Windows, and silentcast or byzanz on Linux.
  • If the problem happens randomly, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

  • Can you reproduce the problem in latest release of software and tools?
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
  • If the problem is related to embARC applications, please go to the embARC applications repository and report it by filing an issue against that repository

Include details about your configuration and development environment:

  • Which version of embARC OSP are you using? Provide the release version or commit of embARC OSP.
  • Provide name and version of the OS and toolchain you are using
  • Provide hardware board and arc core you are using

Requesting Enhancements

This section guides you through submitting enhancement requests for ARC Development Systems, either new features or minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

When you are creating an enhancement suggestion, please include as many details as possible. If you'd like, you can use this template to structure the information.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue against your Development System in this repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most users and isn't something that already existed as similar feature.
Clone this wiki locally