We us redmine to keep track of issues which can be either bugs, feature requests, support requests or optimizations. We want the community to be involved as much as possible and this documentation should give you an overview how we handle issues and what you should keep in mind when you submit an issue.
Submit an issue¶
If you submit an issue be as precise as possible and include all relevant information. If you want to include configuration, long log output or pcap files please attach them and don't paste them in the comment section. Especially for bug reports you should try to create a reproducible scenario and add information like suricata version, build-info and also your operation system. Please fill out the affected version field. Try to make sure that all or at least most of the fields are filled out.
Explanation of fields¶
- Tracker: Bug, Feature, Support, Optimization, Task, Documentation, Security
- Subject: Try to be as precise as possible
- Description: Add all relevant informations
- Status: managed by the OISF team
- Priority: managed by the OISF team
- Assignee: We assign issues to the person working on most of the time. OISF Dev means the team is trying to work on that, we use Community ticket to emphasize that we think the community could work on that
- Target version: We try to define which version will include the fix/update on the issue or at least try to define if it will happen soon or is TBD
- Affected versions: Add the version(s) affected
- Effort: Effort between low, medium, high to show if it is something that can be done in under one hour or will take some days
- Difficulty: How much skill/knowledge might be needed to work on
Work on issues¶
We encourage the community to work on issues as well. We try to fill the Effort and Difficulty fields so you get a feeling how much time/skill you might need to work on issues. Don't hesitate to ask for help if you want to work on an issue.
While we obviously close issues that are fixed we also close issues that are outdated and didn't got any updates, especially bug reports for old versions will be closed from time to time unless there is an update that the bug is still valid for most recent versions.
You will see this message then:
Hi, we're closing this issue since there have been no further responses. If you think this issue is still relevant, try to test it again with the most recent version of suricata and reopen the issue. If you want to improve the bug report please take a look at https://redmine.openinfosecfoundation.org/projects/suricata/wiki/Reporting_Bugs