Skip to content

Issue Reporting

Andrey Kurilov edited this page Oct 8, 2017 · 12 revisions

Defect

When reporting a bug make sure the ticket contains the following info:

  1. Specific conditions.

    1. The mongoose version used.

    2. The particular CLI command.

      Leave only the essential things to reproduce: try to check if possible if the bug is reproducible using single local storage driver, different concurrency level, item data size, etc.

    3. The scenario file used.

      Note that the default scenario is used implicitly. Please don't clutter with large bedsheet scenario files. Simplify the scenario leaving only the essential things.

  2. Expected behavior.

    Specifying the reference to the particular documentation part describing the expected behavior would be great.

  3. Observed behavior.

    Error message, errors.log output file, etc.

Feature

Information Required

A requester should supply the information necessary to deliver any new functionality.

  1. Introduction

    Mandatory for a requester

    Purpose. Which particular problem should be solved with Mongoose?

    1. Links

      The links to the related documents and literature.

  2. Requirements

    1. Functional

      Mandatory for a requester

      The list of the functional requirements. The list should be numbered in order to make it easy to refer to the particular requirements item.

      1. Mandatory Requirements

        Mandatory for a requester

      2. Additional Requirements

        Optional for a requester

      3. Possible Enhancements

        Optional for a requester

    2. Performance

      1. Mandatory Requirements

        Mandatory for a requester

      2. Additional Requirements

        Optional for a requester

  3. Limitations

    Optional for a requester

    List of limitations.

  4. Proposal

    1. Design

      Optional for a requester

      Describe the possible way to get the required functionality working.

    2. Input

      1. Configuration

        Mandatory for a requester

        Describe the possible new configuration options involved.

      2. Other Input

        Optional for a requester

        Any other input required. Scenarios, external files, etc. Optional for a requester.

    3. Output

      1. Standard Output

        Mandatory for a requester

      2. Log Files

        Mandatory for a requester

      3. Other Output

        Optional for a requester

Implementation Lifecycle

  1. Requested
  2. Requirements Available
  3. Specification Available
  4. Estimated
  5. Scheduled
  6. Under Development
  7. Tested Manually
  8. Usage Documentation Available
  9. Released
  10. Covered With Automated Tests
  11. Enhanced
Clone this wiki locally