From e471759be8639b00196cdb8ab17ca4a7ddb565d2 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Fri, 16 May 2014 11:58:06 +0100 Subject: [PATCH] Update README with issues information --- README.adoc | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 47598f012a..5a7594a3bd 100644 --- a/README.adoc +++ b/README.adoc @@ -66,7 +66,26 @@ Having trouble with Spring Boot, We'd like to help! you are just starting out with Spring, try one of the http://spring.io/guides[guides]. * Ask a questions - we monitor http://stackoverflow.com[stackoverflow.com] for questions tagged with http://stackoverflow.com/tags/spring-boot[`spring-boot`]. -* Report bugs with Spring Boot at https://github.com/spring-projects/spring-boot/issues. +* Report bugs with Spring Boot at https://github.com/spring-projects/spring-boot/issues[github.com/spring-projects/spring-boot/issues]. + + + +== Reporting Issues +Spring Boot uses GitHub's integrated issue tracking system to record bugs and feature +requests. If you want to raise an issue, please follow the recommendations bellow: + +* Before you log a bug, please https://github.com/spring-projects/spring-boot/search?type=Issues[search the issue tracker] + to see if someone has already reported the problem. +* If the issue doesn't already exist, https://github.com/spring-projects/spring-boot/issues/new[create a new issue]. +* Please provide as much information as possible with the issue report, we like to know + the version of Spring Boot that you are using, as well as your Operating System and + JVM version. +* If you need to paste code, or include a stack trace use Markdown ++$$```$$++ escapes + before and after your text. +* If possible try to create a test-case or project that replicates the issue. You can + submit sample projects as pull-requests against the + https://github.com/spring-projects/spring-boot-issues[spring-boot-issues] GitHub + project. Use the issue number for the name of your project.