From e94fa1c9b317bd3747de056ef73408a0a728857a Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Sun, 31 Jan 2016 20:14:10 +0100 Subject: [PATCH] Contribution guide work --- CONTRIBUTING.md | 52 +++++++++++++++++++++++++++++-------------------- 1 file changed, 31 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 05751878..a73c65e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,17 +13,19 @@ If GLFW is crashing or triggering asserts, make sure that all your object handles and other pointers are valid. Always include the __operating system name and version__ (i.e. `Windows -7 64-bit`). If you are using an official release of GLFW, include the __GLFW -release version__ (i.e. `3.1.2`), otherwise include the __GLFW commit ID__ (i.e. -`3795d78b14ef06008889cc422a1fb8d642597751`) from Git. If possible, please also -include the __GLFW version string__ (`"3.2.0 X11 EGL clock_gettime /dev/js XI -Xf86vm"`), as returned by glfwGetVersionString. +7 64-bit` or `Ubuntu 15.10`). If you are using an official release of GLFW, +include the __GLFW release version__ (i.e. `3.1.2`), otherwise include the +__GLFW commit ID__ (i.e. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git. +If possible, please also include the __GLFW version string__ (`3.2.0 X11 EGL +clock_gettime /dev/js XI Xf86vm`), as described +[here](http://www.glfw.org/docs/latest/intro.html#intro_version_string). ### Reporting a compile or link bug -In addition to the information above, always include the complete build log. -Issue posts are editable so it can always be shortened later. +In addition to the information above, always include the complete build log from +your compiler and linker. Issue posts are editable so it can always be +shortened later. ### Reporting a context creation bug @@ -34,13 +36,15 @@ GLFW says that your machine lacks support for OpenGL, it very likely does. __Note:__ AMD only supports OpenGL ES on Windows via EGL, which is not enabled in GLFW by default. You need to enable EGL when compiling GLFW to use this. -The `glfwinfo` tool lets you request any kind of context and framebuffer format -supported by the GLFW API without having to recompile. If context creation -fails in your application, please verify that it also fails with this tool -before reporting it as a bug. +The `glfwinfo` tool is included in the GLFW source tree as `tests/glfwinfo.c` +and is built along with the library. It lets you request any kind of context +and framebuffer format supported by the GLFW API without having to recompile. +If context creation fails in your application, please verify that it also fails +with this tool before reporting it as a bug. -In addition to the information above, always include the __GPU model and driver -version__ (i.e. `GeForce GTX660 with 352.79`) when reporting this kind of bug. +In addition to the information above (OS and GLFW version), always include the +__GPU model and driver version__ (i.e. `GeForce GTX660 with 352.79`) when +reporting this kind of bug. ### Reporting a monitor or video mode bug @@ -49,19 +53,25 @@ __Note:__ On headless systems on some platforms, no monitors are reported. This causes glfwGetPrimaryMonitor to return `NULL`, which not all applications are prepared for. -The `monitors` tool lists all information about connected monitors made -available by GLFW. +The `monitors` tool is included in the GLFW source tree as `tests/monitors.c` +and is built along with the library. lists all information about connected +monitors made available by GLFW. -In addition to the information above, if possible please also include the output -of the `monitors` tool when reporting this kind of bug. +In addition to the information above (OS and GLFW version), please also include +the output of the `monitors` tool when reporting this kind of bug. If it +doesn't work at all, please mention this. ### Reporting a window event bug -The `events` tool prints all information provided to every callback supported by -GLFW as events occur. Each event is listed with the time and a unique number -to make discussions about event logs easier. The tool has command-line options -for creating multiple windows and full screen windows. +__Note:__ While GLFW tries to provide the exact same behavior between platforms, +the exact ordering of related window events will sometimes differ. + +The `events` tool is included in the GLFW source tree as `tests/events.c` and is +built along with the library. It prints all information provided to every +callback supported by GLFW as events occur. Each event is listed with the time +and a unique number to make discussions about event logs easier. The tool has +command-line options for creating multiple windows and full screen windows. ### Reporting a documentation bug