docs: better docs, mv doxygen to sphinx
[vpp.git] / docs / contributing / reportingissues / index.rst
1 .. _reportingissues:
2
3 Reporting Bugs
4 ==============
5
6 Although every situation is different, this section describes how to
7 collect data which will help make efficient use of everyone's time
8 when dealing with vpp bugs.
9
10 Before you press the Jira button to create a bug report - or email
11 vpp-dev@lists.fd.io - please ask yourself whether there's enough
12 information for someone else to understand and to reproduce the issue
13 given a reasonable amount of effort. **Unicast emails to maintainers,
14 committers, and the project PTL are strongly discouraged.**
15
16 A good strategy for clear-cut bugs: file a detailed Jira ticket, and
17 then send a short description of the issue to vpp-dev@lists.fd.io,
18 perhaps from the Jira ticket description. It's fine to send email to
19 vpp-dev@lists.fd.io to ask a few questions **before** filing Jira tickets.
20
21 .. toctree::
22
23   reportingissues