From 83f5e1d57f028fbc7253a44285e3de35390f81df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Fri, 5 May 2017 17:25:00 +0200 Subject: [PATCH 1/4] Add link to the Slack support channel --- contributing/code/bugs.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/contributing/code/bugs.rst b/contributing/code/bugs.rst index ff7a54bc013..603dc93f4d0 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 #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: @@ -36,5 +37,6 @@ If your problem definitely looks like a bug, report it using the official bug .. _`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/ From 2972d234737be34bd8f223a39f636f548d324c8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Fri, 5 May 2017 17:17:32 +0200 Subject: [PATCH 2/4] Explain how to provide a stack trace --- contributing/code/bugs.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/contributing/code/bugs.rst b/contributing/code/bugs.rst index 603dc93f4d0..2e050b26a74 100644 --- a/contributing/code/bugs.rst +++ b/contributing/code/bugs.rst @@ -33,6 +33,15 @@ 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 `
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 @@ -40,3 +49,4 @@ If your problem definitely looks like a bug, report it using the official bug .. _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 From 6d3ecc94cc08eacc1e45328420d4b64f20691eb7 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Wed, 17 May 2017 09:01:05 +0200 Subject: [PATCH 3/4] Minor changes --- contributing/code/bugs.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/contributing/code/bugs.rst b/contributing/code/bugs.rst index 2e050b26a74..1e2b745f923 100644 --- a/contributing/code/bugs.rst +++ b/contributing/code/bugs.rst @@ -14,9 +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`_ 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. +* 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: @@ -33,11 +33,11 @@ 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 +* 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 + 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.** From 1648c6f401f03ed5f13319692fd76ddd36df90ee Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Wed, 17 May 2017 09:01:38 +0200 Subject: [PATCH 4/4] Minor fix --- contributing/code/bugs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contributing/code/bugs.rst b/contributing/code/bugs.rst index 1e2b745f923..329c2a6a388 100644 --- a/contributing/code/bugs.rst +++ b/contributing/code/bugs.rst @@ -38,7 +38,7 @@ If your problem definitely looks like a bug, report it using the official bug 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`_. + 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.** @@ -49,4 +49,4 @@ If your problem definitely looks like a bug, report it using the official bug .. _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 +.. _
HTML tag: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details