Skip to content

Commit f454943

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

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

contributing/code/bugs.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,20 @@ 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 you got on an html page, be sure to
37+
provide the plain text version, which should appear at the bottom of the
38+
page. *Do not* provide it as a screenshot, since search engines will not be
39+
able to index the text inside them. Same goes for errors encountered in a
40+
terminal, do not take a screenshot, but learn how to copy/paste from it. If
41+
the stack trace is long, consider enclosing it in a ` ``<details>`` html tag`_.
42+
**Be wary that stack traces may contain sensitive information, and if it is
43+
the case, be sure to redact them prior to posting your stack trace.**
44+
3645
* *(optional)* Attach a :doc:`patch <patches>`.
3746

3847
.. _`Stack Overflow`: http://stackoverflow.com/questions/tagged/symfony2
3948
.. _IRC channel: https://symfony.com/irc
4049
.. _the Symfony Slack: https://symfony.com/slack-invite
4150
.. _tracker: https://github.com/symfony/symfony/issues
4251
.. _Symfony Standard Edition: https://github.com/symfony/symfony-standard/
52+
.. _ ``<details>`` html tag: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details

0 commit comments

Comments
 (0)