We appreciate your interest in contributing to SDL, this document will describe how to report bugs, contribute code or ideas or edit documentation.
Table Of Contents
If you think you have found a bug and would like to report it, here are the steps you should take:
If you want to suggest changes for the project, here are the steps you should take:
This section will cover how the process of forking the project, making a change and opening a pull request.
The first step consists in making a fork of the project, this is only necessary for the first contribution.
Head over to https://github.com/libsdl-org/SDL and click on the
Fork button in the top right corner of your screen, you may leave the fields unchanged and click
You will be redirected to your fork of the repository, click the green
Code button and copy the git clone link.
If you had already forked the repository, you may update it from the web page using the
Fetch upstream button.
Code formatting is done using a custom
.clang-format file, you can learn more about how to run it here.
Some legacy code may not be formatted, as such avoid formatting the whole file at once and only format around your changes.
For your commit message to be properly displayed on GitHub, it should contain:
Fix crash in SDL_FooBar. This addresses the issue #123456 by making sure Foo was successful before calling Bar.
Tests allow you to verify if your changes did not break any behaviour, here are the steps to follow:
testautomation suite on your machine, there should be no more failing tests after your change than before.
Contribute button and
Open Pull Request.
The wiki documentation for API functions is synchronised from the headers' doxygen comments. As such, all modifications to syntax; function parameters; return value; version; related functions should be done in the header directly.
Other changes to the wiki should done directly from https://wiki.libsdl.org/