git repos / blockattack-game

blame: CONTRIBUTING.md

normal view · raw

bbf54672 Poul Sander 2022-01-10 18:07 1
# Contributing
bbf54672 Poul Sander 2022-01-10 18:07 2
bbf54672 Poul Sander 2022-01-10 18:07 3
## Introduction
bbf54672 Poul Sander 2022-01-10 18:07 4
This is an Open Source project and contributions are welcome.
bbf54672 Poul Sander 2022-01-10 18:07 5
bbf54672 Poul Sander 2022-01-10 18:07 6
Both the current graphics and the original sharedir support was provided by kind individuals.
bbf54672 Poul Sander 2022-01-10 18:07 7
Patches can be attached to a github ticket or sent to poul@poulsander.com directly. You can also create pull requests on Github.
bbf54672 Poul Sander 2022-01-10 18:07 8
bbf54672 Poul Sander 2022-01-10 18:07 9
## Coding
bbf54672 Poul Sander 2022-01-10 18:07 10
The project must compile on the olders support LTS version of Ubuntu. It should also be tested on Fedora.
bbf54672 Poul Sander 2022-01-10 18:07 11
bbf54672 Poul Sander 2022-01-10 18:07 12
If any dependecies are not provided they must be embedded.
bbf54672 Poul Sander 2022-01-10 18:07 13
bbf54672 Poul Sander 2022-01-10 18:07 14
Except for official repositories no internet access should be needed.
bbf54672 Poul Sander 2022-01-10 18:07 15
bbf54672 Poul Sander 2022-01-10 18:07 16
Code formatting. The code formatting is handled by astyle. The script `source/misc/astyle/runAstyle.sh`
bbf54672 Poul Sander 2022-01-10 18:07 17
bbf54672 Poul Sander 2022-01-10 18:07 18
Windows version is compiled using MXE and docker.
bbf54672 Poul Sander 2022-01-10 18:07 19
bbf54672 Poul Sander 2022-01-10 18:07 20
## Translations
bbf54672 Poul Sander 2022-01-10 18:07 21
Want to translate to a new language?
bbf54672 Poul Sander 2022-01-10 18:07 22
bbf54672 Poul Sander 2022-01-10 18:07 23
This project uses po-files for translations.
bbf54672 Poul Sander 2022-01-10 18:07 24
bbf54672 Poul Sander 2022-01-10 18:07 25
The template file can be found in `source/misc/translation/template/blockattack_roftb.pot`. Programs like Poedit (https://poedit.net/) can be used to translate the files.
bbf54672 Poul Sander 2022-01-10 18:07 26
bbf54672 Poul Sander 2022-01-10 18:07 27
The resulting po files should be in: `source/misc/translation/po/`
bbf54672 Poul Sander 2022-01-10 18:07 28
bbf54672 Poul Sander 2022-01-10 18:07 29
Or just open a ticket and attach the po-file.
1970-01-01 00:00 30