Explain how to provide a stack trace #7875
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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`_ on the #symfony `IRC channel`_, or on | ||
| the #support channel of `the Symfony Slack`_ 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 learn how to copy/paste from it. 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.** | ||
|
There was a problem hiding this comment. What's wrong with "redact"? IMO it's very appropriate in this context (I'm saying that because I've seen a lot of "redacted" out there, didn't you?). There was a problem hiding this comment. There was a problem hiding this comment. Did you mean remove instead of redact? There was a problem hiding this comment. No, I did not but you are the second person to ask me that, so let me check the meaning. There was a problem hiding this comment. @alexislefebvre @Pierstoval it really seems appropriate : http://www.linguee.fr/francais-anglais/search?source=anglais&query=redact WDYT? There was a problem hiding this comment. I see both of you are french so maybe you're just unaware that redact is a faux-ami ? There was a problem hiding this comment. You're right, I didn't know the meaning of redact. 😅 Maybe you should simply write edit? There was a problem hiding this comment. I did know the meaning of "redact" so it didn't shocked me 🤣 Even though, if some people are confused, maybe the word should be changed without breaking the global understanding of the paragraph. Not every Symfony user is english-native 🙂 There was a problem hiding this comment. @alexislefebvre edit does not convey the full meaning, and I don't think we should dumb it down with remove. I think people can easily infer the meaning of the word if they don't know it already, and that means they will have learned something, so IMO it's better to stick with that. |
||
|
|
||
| * *(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 | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I'd recommend the opposite: always share the stack traces as images because they offer some protection against Google, etc. Remember that traces can contain sensitive information, so we don't make them searchable on Internet.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO sensitive data is the exception, not the rule, and a big drawback of using them that I did not mention is that you can't copy paste from them, making the work harder for people who want to check files mentioned in it. Also, these images can be resized if too big, which can make the text illegible. Also if not cropped properly, they might contain even more sensitive data, like what the desktop of the reporter looks like. Finally, even with a screenshot, you should redact sensitive information, so...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you expose sensitive information you are already F**ked, posting this in a screenshot will not prevent anyone from abusing this information. Not to mention that search engines can perform OCR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm also for plain text, because it allows search engines to match exception messages that people encounter, so they may be redirected to the correct issue just by googling the exception itself