From b2ddb85e624a17636c938c7d52fc4b3ac96b06dd Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Sun, 12 Oct 2014 15:47:38 +0200 Subject: [PATCH] Added readme paragraph on bug reporting. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index bc13cad9..0ef3a94b 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,21 @@ See the guide in the GLFW documentation. +## Reporting bugs + +Bugs are reported to our [issue tracker](https://github.com/glfw/glfw/issues). +Please always include the name and version of the OS where the bug occurs and +the version of GLFW used. If you have cloned it, include the commit ID used. + +If it's a build issue, please also include the build log and the name and +version of your development environment. + +If it's a context creation issue, please also include the make and model of your +graphics card and the version of your driver. + +This will help both us and other people experiencing the same bug. + + ## Dependencies GLFW bundles a number of dependencies in the `deps/` directory.