mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-22 13:04:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work

Browse Source 
[ci skip]
This commit is contained in:
Camilla Löwy 2017-03-05 16:45:09 +01:00
parent 0e0862cfc7
commit 12dcfd08b8
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
.github/CONTRIBUTING.md vendored
View File

@ -51,6 +51,27 @@ __Don't worry about adding too much information__. Unimportant information can
be abbreviated or removed later, but missing information can stall bug fixing, be abbreviated or removed later, but missing information can stall bug fixing,
especially when your schedule doesn't align with that of the maintainer. especially when your schedule doesn't align with that of the maintainer.
__Please provide text as text, not as images__. This includes code, error
messages and any other text. Text in images cannot be found by other users
searching for the same problem and may have to be re-typed by maintainers when
debugging.
You don't need to manually indent your code or other text to quote it with
GitHub Markdown; just surround it with triple backticks:
```
Some quoted text.
```
You can also add syntax highlighting by appending the common file extension:
```c
int five(void)
{
return 5;
}
```
There are issue labels for both platforms and GPU manufacturers, so there is no There are issue labels for both platforms and GPU manufacturers, so there is no
need to mention these in the subject line. If you do, it will be removed when need to mention these in the subject line. If you do, it will be removed when
the issue is labeled. the issue is labeled.
@ -139,6 +160,9 @@ Always include the __operating system name and version__ (e.g. `Windows
include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the
__GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git. __GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git.
If you are running your program in a virtual machine, please mention this and
include the __VM name and version__ (e.g. `VirtualBox 5.1`).
Please also include the __GLFW version string__ (`3.2.0 X11 EGL clock_gettime Please also include the __GLFW version string__ (`3.2.0 X11 EGL clock_gettime
/dev/js`), as described /dev/js`), as described
[here](http://www.glfw.org/docs/latest/intro.html#intro_version_string), the [here](http://www.glfw.org/docs/latest/intro.html#intro_version_string), the
@ -178,6 +202,9 @@ Always include the __operating system name and version__ (e.g. `Windows
include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the
__GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git. __GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git.
If you are running your program in a virtual machine, please mention this and
include the __VM name and version__ (e.g. `VirtualBox 5.1`).
Please also include any __error messages__ provided to your application via the Please also include any __error messages__ provided to your application via the
[error [error
callback](http://www.glfw.org/docs/latest/intro_guide.html#error_handling) and callback](http://www.glfw.org/docs/latest/intro_guide.html#error_handling) and
@ -215,6 +242,9 @@ Always include the __operating system name and version__ (e.g. `Windows
include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the
__GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git. __GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git.
If you are running your program in a virtual machine, please mention this and
include the __VM name and version__ (e.g. `VirtualBox 5.1`).
Please also include any __error messages__ provided to your application via the Please also include any __error messages__ provided to your application via the
[error [error
callback](http://www.glfw.org/docs/latest/intro_guide.html#error_handling) and callback](http://www.glfw.org/docs/latest/intro_guide.html#error_handling) and