Skip to content

Opening a New Issue

Jump to bottom
liranmauda edited this page Mar 20, 2018 · 9 revisions

When opening a new issue, it's important to record the needed information so that an analysis and/or reproduction can be made.

Our current issue template looks like

### Environment info
- Version: **VERSION**
- Deployment: **AZURE | AWS | GCLOUD | ESX | VBOX | DEV**
- Customer: **NAME**

### Actual behavior
1.

### Expected behavior
1.

### Steps to reproduce
1.

### Screenshots or Logs or other output that would be helpful

  1. Version is the version in which the issue occurred, please write the version number + the build number (you can easily take it from the version screen in the UI or if you're in ssh on the machine, from the package.json)

  2. Deployment - Sometimes certain issues only happen on certain deployments, please write which one used when this issue occurred

  3. Customer - If this is customer reported issue, fill in the customer name. Also remember to set the "customer reported" label. if we found this in our testing then "QA" is the customer name (without the "customer reported" label).

  4. Actual Behavior - Describe what happened, what was wrong in what happened. If you have an idea as to why this happened, or even performed an analysis and know the root cause, write it here. for example:

  • when we are ... while ... via the ... it ...
  1. Expected Behavior - What did you expect to happen in this case ? for example:
  • we should be able to ... without ...
  1. Steps to reproduce - If the issue is reproducible, write which steps were taken in order to reproduce it. If the issue is not reproducible, write what you did before the issue occur and state that you did not manage to repro. for example:
step to reproduce:
1. upload file (1 GB) via the ...
2. See that the status is uploading 
3. delete the file while it is still uploading
4. see that the system is ...

  1. Title - please use a short descriptive title of the issue which conveys what the problem is to someone who is not into all the technical details. so for an example,

    "s3server throws when receiving tag x-screw-me-tag"

    is not very understandable but

    "uploading a file of type .screwme fails"

    is more understandable

  2. Labels We have several types of labels in the issue system.

    1. Severity: please consult Issue Severities

    2. Priority: No need to set

    3. UX tags: If the issue is a UX issue, consult UX Issues for finding the correct type

    4. Area/feature labels: Some areas / features have their own labels such as data placement, ui implementation, system configuration etc. If the issue falls in one of the existing labels, set that label as well.

Clone this wiki locally