Skip to content

Explain how to provide a stack trace #7875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 17, 2017
Merged

Explain how to provide a stack trace #7875

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
83f5e1d
Add link to the Slack support channel
May 5, 2017
2972d23
Explain how to provide a stack trace
May 5, 2017
6d3ecc9
Minor changes
javiereguiluz May 17, 2017
1648c6f
Minor fix
javiereguiluz May 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions contributing/code/bugs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ Before submitting a bug:
* Double-check the official :doc:`documentation </index>` to see if you're not misusing the
framework;

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

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

* If you want to provide a stack trace you got on an HTML page, be sure to
provide the plain text version, which should appear at the bottom of the
page. *Do not* provide it as a screenshot, since search engines will not be
able to index the text inside them. Same goes for errors encountered in a
terminal, do not take a screenshot, but copy/paste the contents. If
the stack trace is long, consider enclosing it in a `<details> HTML tag`_.
**Be wary that stack traces may contain sensitive information, and if it is
the case, be sure to redact them prior to posting your stack trace.**

* *(optional)* Attach a :doc:`patch <patches>`.

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