-
Notifications
You must be signed in to change notification settings - Fork 10
Issue Reporting
When reporting a bug make sure the ticket contains the following info:
-
Specific conditions.
-
The mongoose version used.
-
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.
-
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.
-
-
Expected behavior.
Specifying the reference to the particular documentation part describing the expected behavior would be great.
-
Observed behavior.
Error message, errors.log output file, etc.
A requester should supply the information necessary to deliver any new functionality.
-
Introduction
Mandatory for a requester
Purpose. Which particular problem should be solved with Mongoose?
-
Links
The links to the related documents and literature.
-
-
Requirements
-
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.
-
Mandatory Requirements
Mandatory for a requester
-
Additional Requirements
Optional for a requester
-
Possible Enhancements
Optional for a requester
-
-
Performance
-
Mandatory Requirements
Mandatory for a requester
-
Additional Requirements
Optional for a requester
-
-
-
Limitations
Optional for a requester
List of limitations.
-
Proposal
-
Design
Optional for a requester
Describe the possible way to get the required functionality working.
-
Input
-
Configuration
Mandatory for a requester
Describe the possible new configuration options involved.
-
Other Input
Optional for a requester
Any other input required. Scenarios, external files, etc. Optional for a requester.
-
-
Output
-
Standard Output
Mandatory for a requester
-
Log Files
Mandatory for a requester
-
Other Output
Optional for a requester
-
-
- Requested
- Requirements Available
- Specification Available
- Estimated
- Scheduled
- Under Development
- Tested Manually
- Usage Documentation Available
- Released
- Covered With Automated Tests
- Enhanced
- Overview
- Deployment
- User Guide
- Troubleshooting
- Reference