Navy.gif/glfw
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Contribution guide work

Browse Source
This commit is contained in:
Camilla Berglund 2016-01-31 20:14:10 +01:00
parent 7e91b26bb1
commit e94fa1c9b3
1 changed files with 31 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
CONTRIBUTING.md
View File

@ -13,17 +13,19 @@ If GLFW is crashing or triggering asserts, make sure that all your object
handles and other pointers are valid. handles and other pointers are valid.
Always include the __operating system name and version__ (i.e. `Windows 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 7 64-bit` or `Ubuntu 15.10`). If you are using an official release of GLFW,
release version__ (i.e. `3.1.2`), otherwise include the __GLFW commit ID__ (i.e. include the __GLFW release version__ (i.e. `3.1.2`), otherwise include the
`3795d78b14ef06008889cc422a1fb8d642597751`) from Git. If possible, please also __GLFW commit ID__ (i.e. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git.
include the __GLFW version string__ (`"3.2.0 X11 EGL clock_gettime /dev/js XI If possible, please also include the __GLFW version string__ (`3.2.0 X11 EGL
Xf86vm"`), as returned by glfwGetVersionString. 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 ### Reporting a compile or link bug
In addition to the information above, always include the complete build log. In addition to the information above, always include the complete build log from
Issue posts are editable so it can always be shortened later. your compiler and linker. Issue posts are editable so it can always be
shortened later.
### Reporting a context creation bug ### 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 __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. 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 The `glfwinfo` tool is included in the GLFW source tree as `tests/glfwinfo.c`
supported by the GLFW API without having to recompile. If context creation and is built along with the library. It lets you request any kind of context
fails in your application, please verify that it also fails with this tool and framebuffer format supported by the GLFW API without having to recompile.
before reporting it as a bug. 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 In addition to the information above (OS and GLFW version), always include the
version__ (i.e. `GeForce GTX660 with 352.79`) when reporting this kind of bug. __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 ### 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 causes glfwGetPrimaryMonitor to return `NULL`, which not all applications are
prepared for. prepared for.
The `monitors` tool lists all information about connected monitors made The `monitors` tool is included in the GLFW source tree as `tests/monitors.c`
available by GLFW. 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 In addition to the information above (OS and GLFW version), please also include
of the `monitors` tool when reporting this kind of bug. 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 ### Reporting a window event bug
The `events` tool prints all information provided to every callback supported by __Note:__ While GLFW tries to provide the exact same behavior between platforms,
GLFW as events occur. Each event is listed with the time and a unique number the exact ordering of related window events will sometimes differ.
to make discussions about event logs easier. The tool has command-line options
for creating multiple windows and full screen windows. 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 ### Reporting a documentation bug