Skip to content

Commit 1b8ed9f

Browse files
author
Grégoire Paris
committed
Explain how to provide a stack trace
1 parent 83f5e1d commit 1b8ed9f

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

contributing/code/bugs.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ If your problem definitely looks like a bug, report it using the official bug
3333
* Give as much detail as possible about your environment (OS, PHP version,
3434
Symfony version, enabled extensions, ...);
3535

36+
* If you want to provide a stack trace, be sure to provide the plain text
37+
version, which should appear at the bottom of the page. *Do not* provide it
38+
as a screenshot, since search engines will not be able to index the text
39+
inside them. If the stack trace is long, consider enclosing it in a
40+
``<details>`` html tag. Be wary that stack traces may contain sensible
41+
information, and if it is the case, be sure to redact them prior to posting
42+
your stack trace.
43+
3644
* *(optional)* Attach a :doc:`patch <patches>`.
3745

3846
.. _`Stack Overflow`: http://stackoverflow.com/questions/tagged/symfony2

0 commit comments

Comments
 (0)