Skip to content

Commit bb0cfaa

Browse files
committed
minor #7875 Explain how to provide a stack trace (greg0ire, javiereguiluz)
This PR was merged into the 2.7 branch. Discussion ---------- Explain how to provide a stack trace I miss a reference explaining how to do that properly and keep asking people to do it, so maybe here is the right place? Commits ------- 1648c6f Minor fix 6d3ecc9 Minor changes 2972d23 Explain how to provide a stack trace 83f5e1d Add link to the Slack support channel
2 parents ca895b2 + 1648c6f commit bb0cfaa

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

contributing/code/bugs.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ Before submitting a bug:
1414
* Double-check the official :doc:`documentation </index>` to see if you're not misusing the
1515
framework;
1616

17-
* Ask for assistance on `Stack Overflow`_ or on the #symfony `IRC channel`_
18-
if you're not sure if your issue is really a bug.
17+
* Ask for assistance on `Stack Overflow`_, on the #support channel of
18+
`the Symfony Slack`_, or on the #symfony `IRC channel`_ if you're not sure if
19+
your issue is really a bug.
1920

2021
If your problem definitely looks like a bug, report it using the official bug
2122
`tracker`_ and follow some basic rules:
@@ -32,9 +33,20 @@ If your problem definitely looks like a bug, report it using the official bug
3233
* Give as much detail as possible about your environment (OS, PHP version,
3334
Symfony version, enabled extensions, ...);
3435

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 copy/paste the contents. 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+
3545
* *(optional)* Attach a :doc:`patch <patches>`.
3646

3747
.. _`Stack Overflow`: http://stackoverflow.com/questions/tagged/symfony2
3848
.. _IRC channel: https://symfony.com/irc
49+
.. _the Symfony Slack: https://symfony.com/slack-invite
3950
.. _tracker: https://github.com/symfony/symfony/issues
4051
.. _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)