diff --git a/contributing/code/bugs.rst b/contributing/code/bugs.rst index ff7a54bc013..329c2a6a388 100644 --- a/contributing/code/bugs.rst +++ b/contributing/code/bugs.rst @@ -14,8 +14,9 @@ Before submitting a bug: * Double-check the official :doc:`documentation ` 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: @@ -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 `
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 `. .. _`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/ +.. _
HTML tag: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details