eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-06-01 09:27:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Document the SDL-specific custom ci commands

Browse source
This commit is contained in:
Anonymous Maarten 2024-08-31 01:29:23 +02:00 • committed by Anonymous Maarten
parent ea0ab2647a
commit c57cf716af
3 changed files with 24 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/README-contributing.md
View file

@ -12,6 +12,7 @@ We appreciate your interest in contributing to SDL, this document will describe
- [Following the style guide](#following-the-style-guide)
- [Running the tests](#running-the-tests)
- [Opening a pull request](#opening-a-pull-request)
- [Continuous integration](#continuous-integration)
- [Contributing to the documentation](#contributing-to-the-documentation)
- [Editing a function documentation](#editing-a-function-documentation)
- [Editing the wiki](#editing-the-wiki)
@ -86,6 +87,15 @@ Tests allow you to verify if your changes did not break any behaviour, here are
- Fill out the pull request template.
- If any changes are requested, you can add new commits to your fork and they will be automatically added to the pull request.
### Continuous integration
For each push and/or pull request, GitHub Actions will try to build SDL and the test suite on most supported platforms.
Its behaviour can be influenced slightly by including SDL-specific tags in your commit message:
- `[sdl-ci-filter GLOB]` limits the platforms for which to run ci.
- `[sdl-ci-artifacts]` forces SDL artifacts, which can then be downloaded from the summary page.
- `[sdl-ci-trackmem-symbol-names]` makes sure the final report generated by `--trackmem` contains symbol names.
## Contributing to the documentation
### Editing a function documentation