Merge pull request #3683 from greg0ire/how_to_report_bugs

How to report bugs

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,23 @@
+Delete this sentence after you read the "Reporting bugs" paragraph from the
+"guidelines for contributing" link above.
+
+If you are reporting a bug, please try to fill in the following, otherwise
+remove it along with this sentence.
+
+| Question       | Answer
+|----------------|-------------------------------------------------------------
+| Bundle version | composer show --installed | grep sonata-project/admin-bundle
+| Symfony version| composer show --installed | grep symfony/symfony
+| php version    | php --version
+
+# Error message
+
+```
+Error message goes here
+```
+
+# Steps to reproduce
+
+# Expected results
+
+# Actual results

CONTRIBUTING.md

@@ -1,18 +1,38 @@
-Sonata respects the Symfony's conventions about contributing to the code. So before going further please review the [contributing documentation of Symfony](http://symfony.com/doc/current/contributing/code/patches.html#make-a-pull-request).
+Sonata respects the Symfony's conventions about contributing to the code. So
+before going further please review the [contributing documentation of
+Symfony](http://symfony.com/doc/current/contributing/code/patches.html#make-a-pull-request).
 
 ## Reporting bugs
 
-If you happen to find a bug, we kindly request you to report it. However, before submitting it, please:
-
-  * Check the [project documentation available online](https://sonata-project.org/bundles/)
-
-Then, if it appears that it's a real bug, you may report it using Github by following these 3 points:
-
-  * Check if the bug is not already reported!
-  * A clear title to resume the issue
-  * A description of the workflow needed to reproduce the bug,
-
-> _NOTE:_ Don't hesitate giving as much information as you can (OS, PHP version extensions...)
+If you are not sure this is a bug, consider posting your question on [Stack
+Overflow](http://stackoverflow.com), using one of the sonata tags.
+If you happen to find a bug, we kindly request you to report it. However,
+before submitting it, please check the [project documentation available
+online](https://sonata-project.org/bundles/)
+
+Then, if it appears that it's a real bug, you may report it using Github by
+following these points:
+
+* Check if the bug is not already reported!
+* A clear title to sum up the issue
+* A description of the workflow needed to reproduce the bug
+* If your issue is an error page, you must provide us with a stack trace.  With
+  recent version of Symfony, you can even get stack traces as plain text at the
+end of the page. Just look for "Stack Trace (Plain Text)", and copy/paste what
+you see. **Do not** make a screenshot of the stack trace, as screenshots are
+not indexed by search engines and will make it difficult for other people to
+find your bug report. Screenshots should be considered additional data, you
+should always provide a textual description of the bug. It is strongly
+recommended to provide them when reporting UI-related bugs.
+* If you need to provide code, make sure you know how to get syntactic
+  coloration, in particular with [fenced code
+blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/).
+When you feel the code is to long, use external code pastebin like
+https://gist.github.com/ or http://hastebin.com/ . If this is not sufficient,
+just create a repository to show the issue.
+
+> _NOTE:_ Don't hesitate giving as much information as you can (OS, PHP
+> version, extensions...)
 
 ## Pull requests
 
@@ -29,7 +49,8 @@ recent branches.
 
 ### Matching coding standards
 
-Before each commit, be sure to match sonata coding standards by running the following command for fix:
+Before each commit, be sure to match sonata coding standards by running the
+following command for fix:
 
 ```bash
 make cs
@@ -37,7 +58,8 @@ make cs
 
 And then, add fixed file to your commit before push.
 
-Be sure to add only **your modified files**. If another files are fixed by cs tools, just revert it before commit.
+Be sure to add only **your modified files**. If another files are fixed by cs
+tools, just revert it before commit.
 
 ### Sending a Pull Request
 
@@ -46,10 +68,14 @@ When you send a PR, just make sure that:
 * You add valid test cases.
 * Tests are green.
 * The related documentation is up-to-date.
-* You make the PR on the same branch you based your changes on. If you see commits
-that you did not make in your PR, you're doing it wrong.
-* Also don't forget to add a comment when you update a PR with a ping to the maintainer (``@username``), so he/she will get a notification.
+* You make the PR on the same branch you based your changes on. If you see
+  commits that you did not make in your PR, you're doing it wrong.
+* Also don't forget to add a comment when you update a PR with a ping to the
+  maintainer (``@username``), so he/she will get a notification.
 * Squash your commits into one commit. (see the next chapter)
+* Some changes, especially UI changes, might affect other bundles. If you think
+  this is the case, we recommend you test your changes against [the Sonata
+sandbox](https://github.com/sonata-project/sandbox).
 
 ## Squash your commits
 
@@ -70,11 +96,13 @@ git rebase -i HEAD~3
 
 An editor will be opened with your 3 commits, all prefixed by `pick`.
 
-Replace all `pick` prefixes by `fixup` (or `f`) **except the first commit** of the list.
+Replace all `pick` prefixes by `fixup` (or `f`) **except the first commit** of
+the list.
 
 Save and quit the editor.
 
-After that, all your commits where squashed into the first one and the commit message of the first commit.
+After that, all your commits where squashed into the first one and the commit
+message of the first commit.
 
 If you would like to rename your commit message type: